RubyGems - passenger - Versions diffs - 3.0.4 → 3.0.5 - Mend

passenger 3.0.4 → 3.0.5

Potentially problematic release.

This version of passenger might be problematic. Click here for more details.

Files changed (571) hide show

@@ -0,0 +1,87 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: Class List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a></td><td class="indexvalue">Spawning of application processes </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td class="indexvalue">Abstract base class for watching agent processes </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1ArgumentException.html">Passenger::ArgumentException</a></td><td class="indexvalue">Indicates that a specified argument is incorrect or violates a requirement </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1ArrayMessage.html">Passenger::ArrayMessage</a></td><td class="indexvalue">For array messages </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1BufferedUpload.html">Passenger::BufferedUpload</a></td><td class="indexvalue">Represents a buffered upload file </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1BusyException.html">Passenger::BusyException</a></td><td class="indexvalue">The application pool is too busy and cannot fulfill a get() request </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classClient.html">Client</a></td><td class="indexvalue">A representation of a <a class="el" href="classClient.html" title="A representation of a Client from the Server&#39;s point of view.">Client</a> from the Server's point of view </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1MessageServer_1_1ClientContext.html">Passenger::MessageServer::ClientContext</a></td><td class="indexvalue">Interface for client context objects </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">Passenger::MessageServer::CommonClientContext</a></td><td class="indexvalue">A common client context, containing client-specific information used by <a class="el" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a> itself </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1ConfigurationException.html">Passenger::ConfigurationException</a></td><td class="indexvalue">Thrown when an invalid configuration is given </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td class="indexvalue">Utility class for determining URI-to-application directory mappings </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html">Passenger::MessageServer::DisconnectEventBroadcastGuard</a></td><td class="indexvalue">Calls clientDisconnected() on all handlers when destroyed </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1EOFException.html">Passenger::EOFException</a></td><td class="indexvalue">An unexpected end-of-file I/O error </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1EventedClient.html">Passenger::EventedClient</a></td><td class="indexvalue">A utility class for making I/O handling in non-blocking libev evented servers much easier </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1EventedMessageServer.html">Passenger::EventedMessageServer</a></td><td class="indexvalue">Note when overriding onNewClient: call the parent method first! It does some initialization but might disconnect the client if that initialization fails </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1EventedServer.html">Passenger::EventedServer</a></td><td class="indexvalue">A base class for writing single-threaded, evented servers that use non-blocking I/O </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1EventFd.html">Passenger::EventFd</a></td><td class="indexvalue">A synchronization mechanism that's implemented with file descriptors, and as such can be used in combination with select() and friends </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1FileDescriptor.html">Passenger::FileDescriptor</a></td><td class="indexvalue">Wrapper class around a file descriptor integer, for RAII behavior </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1FileDescriptorPair.html">Passenger::FileDescriptorPair</a></td><td class="indexvalue">A structure containing two <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> objects </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1FileNotFoundException.html">Passenger::FileNotFoundException</a></td><td class="indexvalue">Thrown when a certain file cannot be found </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1FileSystemException.html">Passenger::FileSystemException</a></td><td class="indexvalue">A filesystem error, as returned by the operating system </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1MessageServer_1_1Handler.html">Passenger::MessageServer::Handler</a></td><td class="indexvalue">An abstract message handler class </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structPassenger_1_1StaticString_1_1Hash.html">Passenger::StaticString::Hash</a></td><td class="indexvalue">A hash function object for <a class="el" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classHooks.html">Hooks</a></td><td class="indexvalue">Apache hook functions, wrapped in a class </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1HttpStatusExtractor.html">Passenger::HttpStatusExtractor</a></td><td class="indexvalue">Utility class for extracting the HTTP status value from an HTTP response </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1IOException.html">Passenger::IOException</a></td><td class="indexvalue">Represents an error that occured during an I/O operation </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1MessageChannel.html">Passenger::MessageChannel</a></td><td class="indexvalue">Convenience class for I/O operations on file descriptors </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1MessageServer.html">Passenger::MessageServer</a></td><td class="indexvalue">Simple pluggable request/response messaging server framework </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structPassenger_1_1PoolOptions.html">Passenger::PoolOptions</a></td><td class="indexvalue">This struct encapsulates information for ApplicationPool::get() and for <a class="el" href="classPassenger_1_1SpawnManager.html#a88a94ba4d41dab492cb1dc8a0f998973" title="Spawn a new application process.">SpawnManager::spawn()</a>, such as which application is to be spawned </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1Process.html">Passenger::Process</a></td><td class="indexvalue">Represents a single application process, as spawned by <a class="el" href="classPassenger_1_1SpawnManager.html" title="An AbstractSpawnManager implementation.">SpawnManager</a> or by ApplicationPool::Interface::get() </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1RandomGenerator.html">Passenger::RandomGenerator</a></td><td class="indexvalue">A random data generator </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1ResourceLocator.html">Passenger::ResourceLocator</a></td><td class="indexvalue">Locates various Phusion <a class="el" href="namespacePassenger.html" title="Common code for all agents.">Passenger</a> resources on the filesystem </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1RuntimeException.html">Passenger::RuntimeException</a></td><td class="indexvalue">A generic runtime exception </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1SafeLibev.html">Passenger::SafeLibev</a></td><td class="indexvalue">Class for thread-safely using libev </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1ScalarMessage.html">Passenger::ScalarMessage</a></td><td class="indexvalue">Class for reading a scalar message </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1ScgiRequestParser.html">Passenger::ScgiRequestParser</a></td><td class="indexvalue">A parser for SCGI requests </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1SecurityException.html">Passenger::SecurityException</a></td><td class="indexvalue">Represents some kind of security error </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classServer.html">Server</a></td><td class="indexvalue">A representation of the <a class="el" href="classServer.html" title="A representation of the Server responsible for handling Client instances.">Server</a> responsible for handling <a class="el" href="classClient.html" title="A representation of a Client from the Server&#39;s point of view.">Client</a> instances </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classServerInstanceDirToucher.html">ServerInstanceDirToucher</a></td><td class="indexvalue">Touch all files in the server instance dir every 6 hours in order to prevent /tmp cleaners from weaking havoc: <a href="http://code.google.com/p/phusion-passenger/issues/detail?id=365">http://code.google.com/p/phusion-passenger/issues/detail?id=365</a> </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1Session.html">Passenger::Session</a></td><td class="indexvalue">Represents a single request/response pair of an application process </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1SpawnException.html">Passenger::SpawnException</a></td><td class="indexvalue">Thrown when <a class="el" href="classPassenger_1_1SpawnManager.html" title="An AbstractSpawnManager implementation.">SpawnManager</a> or ApplicationPool fails to spawn an application instance </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1SpawnManager.html">Passenger::SpawnManager</a></td><td class="indexvalue">An <a class="el" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> implementation </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1StandardSession.html">Passenger::StandardSession</a></td><td class="indexvalue">A "standard" implementation of <a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1StaticString.html">Passenger::StaticString</a></td><td class="indexvalue">An immutable, static byte buffer </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1SyntaxError.html">Passenger::SyntaxError</a></td><td class="indexvalue">A parser detected a syntax error </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1SystemException.html">Passenger::SystemException</a></td><td class="indexvalue">Represents an error returned by a system call or a standard library call </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1TimeoutException.html">Passenger::TimeoutException</a></td><td class="indexvalue">An exception indicating that some timeout expired </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1TimeRetrievalException.html">Passenger::TimeRetrievalException</a></td><td class="indexvalue">Unable to retrieve the system time using <code>time()</code> </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1Uint16Message.html">Passenger::Uint16Message</a></td><td class="indexvalue">For 16-bit big-endian integers </td></tr>
+  <tr><td class="indexkey"><a class="el" href="classPassenger_1_1Uint32Message.html">Passenger::Uint32Message</a></td><td class="indexvalue">For 32-bit big-endian integers </td></tr>
+</table>
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>

data/doc/cxxapi/apache2_2Configuration_8h_source.html ADDED

@@ -0,0 +1,82 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: Configuration.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>Configuration.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00006"></a>00006 <span class="comment"> *</span>
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_CONFIGURATION_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_CONFIGURATION_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;apr_pools.h&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;httpd.h&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;http_config.h&gt;</span>
+<a name="l00031"></a>00031
+<a name="l00032"></a>00032 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00033"></a>00033 <span class="preprocessor"></span>        <span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
+<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
+<a name="l00035"></a>00035 <span class="preprocessor"></span>
+<a name="l00036"></a>00036 <span class="comment"></span>
+<a name="l00037"></a>00037 <span class="comment">/** Configuration hook for per-directory configuration structure creation. */</span>
+<a name="l00038"></a>00038 <span class="keywordtype">void</span> *passenger_config_create_dir(apr_pool_t *p, <span class="keywordtype">char</span> *dirspec);
+<a name="l00039"></a>00039 <span class="comment"></span>
+<a name="l00040"></a>00040 <span class="comment">/** Configuration hook for per-directory configuration structure merging. */</span>
+<a name="l00041"></a>00041 <span class="keywordtype">void</span> *passenger_config_merge_dir(apr_pool_t *p, <span class="keywordtype">void</span> *basev, <span class="keywordtype">void</span> *addv);
+<a name="l00042"></a>00042 <span class="comment"></span>
+<a name="l00043"></a>00043 <span class="comment">/** Apache module commands array. */</span>
+<a name="l00044"></a>00044 <span class="keyword">extern</span> <span class="keyword">const</span> command_rec passenger_commands[];
+<a name="l00045"></a>00045
+<a name="l00046"></a>00046
+<a name="l00047"></a>00047 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00048"></a>00048 <span class="preprocessor"></span>        }
+<a name="l00049"></a>00049 <span class="preprocessor">#endif</span>
+<a name="l00050"></a>00050 <span class="preprocessor"></span>
+<a name="l00051"></a>00051 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_CONFIGURATION_H_ */</span>
+</pre></div></div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>

data/doc/cxxapi/classAgentWatcher-members.html ADDED

@@ -0,0 +1,54 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>AgentWatcher Member List</h1>This is the complete list of members for <a class="el" href="classAgentWatcher.html">AgentWatcher</a>, including all inherited members.<table>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#ac6325cb940f9c25ef2f44aca00c30755">execProgram</a>() const </td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline, protected, virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#aa3eba8fe19117a84764f5f653a03612d">feedbackFd</a></td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [protected]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#ae65876d2cc680b739dfee02378233340">forceShutdown</a>()</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline, virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a80ef9eaf1a84d994e7ba5f1507616fde">getErrorBacktrace</a>() const </td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#ab99d4346d7b69d86db1b14206e7caadb">getErrorMessage</a>() const </td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a77279925d786a774bdf097468c36af96">getExeFilename</a>() const =0</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [protected, pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#ac0749ab103ed5d1adc81b53a7ddc93d8">getFeedbackFd</a>() const </td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a9c50694046e32a8b900420cb473e9e16">killAndWait</a>(pid_t pid)</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline, protected, static]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a22ad2ee317c4e254833ab07f377ed7fd">lock</a></td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [mutable, protected]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a982a388ed5c485ab9615c5bc0abbc71e">name</a>() const =0</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">pid</a></td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [protected]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a4c1c454374c8916788fee166beacfb05">processStartupInfo</a>(pid_t pid, FileDescriptor &amp;fd, const vector&lt; string &gt; &amp;args)=0</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [protected, pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a45bc0e41253a0c287e14f708f7dba1e6">sendStartupArguments</a>(pid_t pid, FileDescriptor &amp;fd)=0</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [protected, pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#aa9f83ed13b06ef80d0417f9c313cf61e">sendStartupInfo</a>(MessageChannel &amp;channel)=0</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#adaf1c0a7104aea662d90f639066b8247">start</a>()</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline, virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a3da11d23ed3b1210a24844856b7f3159">startWatching</a>()</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline, virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#ac4fa4122858073a1e3e1d96ce2ade6f2">threadExceptionMessage</a></td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [protected]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classAgentWatcher.html#a231e843bd6d916650f7e7a641c5b4ca4">timedWaitPid</a>(pid_t pid, int *status, unsigned long long timeout)</td><td><a class="el" href="classAgentWatcher.html">AgentWatcher</a></td><td><code> [inline, protected, static]</code></td></tr>
+</table></div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>

data/doc/cxxapi/classAgentWatcher.html ADDED

@@ -0,0 +1,419 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: AgentWatcher Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>AgentWatcher Class Reference</h1><!-- doxytag: class="AgentWatcher" -->
+<p>Abstract base class for watching agent processes.
+<a href="#_details">More...</a></p>
+<p>Inherited by HelperAgentWatcher, and LoggingAgentWatcher.</p>
+<p><a href="classAgentWatcher-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#aa9f83ed13b06ef80d0417f9c313cf61e">sendStartupInfo</a> (<a class="el" href="classPassenger_1_1MessageChannel.html">MessageChannel</a> &amp;channel)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send the started agent process's startup information over the given channel, to the starter process.  <a href="#aa9f83ed13b06ef80d0417f9c313cf61e"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a982a388ed5c485ab9615c5bc0abbc71e">name</a> () const =0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the agent that this class is watching.  <a href="#a982a388ed5c485ab9615c5bc0abbc71e"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual pid_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#adaf1c0a7104aea662d90f639066b8247">start</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Starts the agent process.  <a href="#adaf1c0a7104aea662d90f639066b8247"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a3da11d23ed3b1210a24844856b7f3159">startWatching</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start watching the agent process.  <a href="#a3da11d23ed3b1210a24844856b7f3159"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#ae65876d2cc680b739dfee02378233340">forceShutdown</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Force the agent process to shut down.  <a href="#ae65876d2cc680b739dfee02378233340"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#ab99d4346d7b69d86db1b14206e7caadb">getErrorMessage</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If the watcher thread has encountered an error, then the error message will be stored here.  <a href="#ab99d4346d7b69d86db1b14206e7caadb"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80ef9eaf1a84d994e7ba5f1507616fde"></a><!-- doxytag: member="AgentWatcher::getErrorBacktrace" ref="a80ef9eaf1a84d994e7ba5f1507616fde" args="() const " -->
+string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a80ef9eaf1a84d994e7ba5f1507616fde">getErrorBacktrace</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The error backtrace, if applicable. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#ac0749ab103ed5d1adc81b53a7ddc93d8">getFeedbackFd</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the agent process feedback fd, or -1 if the agent process hasn't been started yet.  <a href="#ac0749ab103ed5d1adc81b53a7ddc93d8"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a77279925d786a774bdf097468c36af96">getExeFilename</a> () const =0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the filename of the agent process's executable.  <a href="#a77279925d786a774bdf097468c36af96"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#ac6325cb940f9c25ef2f44aca00c30755">execProgram</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is to exec() the agent with the right arguments.  <a href="#ac6325cb940f9c25ef2f44aca00c30755"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a45bc0e41253a0c287e14f708f7dba1e6">sendStartupArguments</a> (pid_t <a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">pid</a>, <a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a> &amp;fd)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is to send startup arguments to the agent process through the given file descriptor, which is the agent process's feedback fd.  <a href="#a45bc0e41253a0c287e14f708f7dba1e6"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a4c1c454374c8916788fee166beacfb05">processStartupInfo</a> (pid_t <a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">pid</a>, <a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a> &amp;fd, const vector&lt; string &gt; &amp;args)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is to process the startup info that the agent process has sent back.  <a href="#a4c1c454374c8916788fee166beacfb05"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Static Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a9c50694046e32a8b900420cb473e9e16">killAndWait</a> (pid_t <a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">pid</a>)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Kill a process with SIGKILL, and attempt to kill its children too.  <a href="#a9c50694046e32a8b900420cb473e9e16"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a231e843bd6d916650f7e7a641c5b4ca4"></a><!-- doxytag: member="AgentWatcher::timedWaitPid" ref="a231e843bd6d916650f7e7a641c5b4ca4" args="(pid_t pid, int *status, unsigned long long timeout)" -->
+static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a231e843bd6d916650f7e7a641c5b4ca4">timedWaitPid</a> (pid_t <a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">pid</a>, int *status, unsigned long long timeout)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Behaves like <code>waitpid(pid, status, WNOHANG)</code>, but waits at most <em>timeout</em> miliseconds for the process to exit. <br/></td></tr>
+<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">pid_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">pid</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">PID of the process we're watching.  <a href="#a76de201bbc7111c01c31668211494fa8"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#ac4fa4122858073a1e3e1d96ce2ade6f2">threadExceptionMessage</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If the watcher thread threw an uncaught exception then its information will be stored here so that the main thread can check whether a watcher encountered an error.  <a href="#ac4fa4122858073a1e3e1d96ce2ade6f2"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#aa3eba8fe19117a84764f5f653a03612d">feedbackFd</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The agent process's feedback fd.  <a href="#aa3eba8fe19117a84764f5f653a03612d"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22ad2ee317c4e254833ab07f377ed7fd"></a><!-- doxytag: member="AgentWatcher::lock" ref="a22ad2ee317c4e254833ab07f377ed7fd" args="" -->
+boost::mutex&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAgentWatcher.html#a22ad2ee317c4e254833ab07f377ed7fd">lock</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock for protecting the exchange of data between the main thread and the watcher thread. <br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Abstract base class for watching agent processes. </p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="ac6325cb940f9c25ef2f44aca00c30755"></a><!-- doxytag: member="AgentWatcher::execProgram" ref="ac6325cb940f9c25ef2f44aca00c30755" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void AgentWatcher::execProgram </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [inline, protected, virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>This method is to exec() the agent with the right arguments. </p>
+<p>It is called from within a forked child process, so don't do any dynamic memory allocations in here. It must also not throw any exceptions. It must also preserve the value of errno after exec() is called. </p>
+</div>
+</div>
+<a class="anchor" id="ae65876d2cc680b739dfee02378233340"></a><!-- doxytag: member="AgentWatcher::forceShutdown" ref="ae65876d2cc680b739dfee02378233340" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual bool AgentWatcher::forceShutdown </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Force the agent process to shut down. </p>
+<p>Returns true if it was shut down, or false if it wasn't started. </p>
+</div>
+</div>
+<a class="anchor" id="ab99d4346d7b69d86db1b14206e7caadb"></a><!-- doxytag: member="AgentWatcher::getErrorMessage" ref="ab99d4346d7b69d86db1b14206e7caadb" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">string AgentWatcher::getErrorMessage </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>If the watcher thread has encountered an error, then the error message will be stored here. </p>
+<p>If the error message is empty then it means everything is still OK. </p>
+</div>
+</div>
+<a class="anchor" id="a77279925d786a774bdf097468c36af96"></a><!-- doxytag: member="AgentWatcher::getExeFilename" ref="a77279925d786a774bdf097468c36af96" args="() const =0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual string AgentWatcher::getExeFilename </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [protected, pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Returns the filename of the agent process's executable. </p>
+<p>This method may be called in a forked child process and may therefore not allocate memory. </p>
+</div>
+</div>
+<a class="anchor" id="ac0749ab103ed5d1adc81b53a7ddc93d8"></a><!-- doxytag: member="AgentWatcher::getFeedbackFd" ref="ac0749ab103ed5d1adc81b53a7ddc93d8" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a> AgentWatcher::getFeedbackFd </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Returns the agent process feedback fd, or -1 if the agent process hasn't been started yet. </p>
+<p>Can be used to check whether this agent process has exited without using waitpid(). </p>
+</div>
+</div>
+<a class="anchor" id="a9c50694046e32a8b900420cb473e9e16"></a><!-- doxytag: member="AgentWatcher::killAndWait" ref="a9c50694046e32a8b900420cb473e9e16" args="(pid_t pid)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">static void AgentWatcher::killAndWait </td>
+          <td>(</td>
+          <td class="paramtype">pid_t&nbsp;</td>
+          <td class="paramname"> <em>pid</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, static, protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Kill a process with SIGKILL, and attempt to kill its children too. </p>
+<p>Then wait until it has quit. </p>
+</div>
+</div>
+<a class="anchor" id="a982a388ed5c485ab9615c5bc0abbc71e"></a><!-- doxytag: member="AgentWatcher::name" ref="a982a388ed5c485ab9615c5bc0abbc71e" args="() const =0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual const char* AgentWatcher::name </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Returns the name of the agent that this class is watching. </p>
+</div>
+</div>
+<a class="anchor" id="a4c1c454374c8916788fee166beacfb05"></a><!-- doxytag: member="AgentWatcher::processStartupInfo" ref="a4c1c454374c8916788fee166beacfb05" args="(pid_t pid, FileDescriptor &amp;fd, const vector&lt; string &gt; &amp;args)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual bool AgentWatcher::processStartupInfo </td>
+          <td>(</td>
+          <td class="paramtype">pid_t&nbsp;</td>
+          <td class="paramname"> <em>pid</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>fd</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const vector&lt; string &gt; &amp;&nbsp;</td>
+          <td class="paramname"> <em>args</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [protected, pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>This method is to process the startup info that the agent process has sent back. </p>
+<p>May throw arbitrary exceptions. </p>
+</div>
+</div>
+<a class="anchor" id="a45bc0e41253a0c287e14f708f7dba1e6"></a><!-- doxytag: member="AgentWatcher::sendStartupArguments" ref="a45bc0e41253a0c287e14f708f7dba1e6" args="(pid_t pid, FileDescriptor &amp;fd)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void AgentWatcher::sendStartupArguments </td>
+          <td>(</td>
+          <td class="paramtype">pid_t&nbsp;</td>
+          <td class="paramname"> <em>pid</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>fd</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [protected, pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>This method is to send startup arguments to the agent process through the given file descriptor, which is the agent process's feedback fd. </p>
+<p>May throw arbitrary exceptions. </p>
+</div>
+</div>
+<a class="anchor" id="aa9f83ed13b06ef80d0417f9c313cf61e"></a><!-- doxytag: member="AgentWatcher::sendStartupInfo" ref="aa9f83ed13b06ef80d0417f9c313cf61e" args="(MessageChannel &amp;channel)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void AgentWatcher::sendStartupInfo </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classPassenger_1_1MessageChannel.html">MessageChannel</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>channel</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Send the started agent process's startup information over the given channel, to the starter process. </p>
+<p>May throw arbitrary exceptions.</p>
+<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classAgentWatcher.html#adaf1c0a7104aea662d90f639066b8247" title="Starts the agent process.">start()</a> has been called and succeeded. </dd></dl>
+</div>
+</div>
+<a class="anchor" id="adaf1c0a7104aea662d90f639066b8247"></a><!-- doxytag: member="AgentWatcher::start" ref="adaf1c0a7104aea662d90f639066b8247" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual pid_t AgentWatcher::start </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Starts the agent process. </p>
+<p>May throw arbitrary exceptions. </p>
+</div>
+</div>
+<a class="anchor" id="a3da11d23ed3b1210a24844856b7f3159"></a><!-- doxytag: member="AgentWatcher::startWatching" ref="a3da11d23ed3b1210a24844856b7f3159" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void AgentWatcher::startWatching </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Start watching the agent process. </p>
+<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classAgentWatcher.html#adaf1c0a7104aea662d90f639066b8247" title="Starts the agent process.">start()</a> has been called and succeeded. </dd>
+<dd>
+This watcher isn't already watching. </dd></dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>RuntimeException</em>&nbsp;</td><td>If a precondition failed. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>thread_interrupted</em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>thread_resource_error</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+</div>
+</div>
+<hr/><h2>Member Data Documentation</h2>
+<a class="anchor" id="aa3eba8fe19117a84764f5f653a03612d"></a><!-- doxytag: member="AgentWatcher::feedbackFd" ref="aa3eba8fe19117a84764f5f653a03612d" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a> <a class="el" href="classAgentWatcher.html#aa3eba8fe19117a84764f5f653a03612d">AgentWatcher::feedbackFd</a><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>The agent process's feedback fd. </p>
+</div>
+</div>
+<a class="anchor" id="a76de201bbc7111c01c31668211494fa8"></a><!-- doxytag: member="AgentWatcher::pid" ref="a76de201bbc7111c01c31668211494fa8" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">pid_t <a class="el" href="classAgentWatcher.html#a76de201bbc7111c01c31668211494fa8">AgentWatcher::pid</a><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>PID of the process we're watching. </p>
+<p>0 if no process is started at this time. </p>
+</div>
+</div>
+<a class="anchor" id="ac4fa4122858073a1e3e1d96ce2ade6f2"></a><!-- doxytag: member="AgentWatcher::threadExceptionMessage" ref="ac4fa4122858073a1e3e1d96ce2ade6f2" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">string <a class="el" href="classAgentWatcher.html#ac4fa4122858073a1e3e1d96ce2ade6f2">AgentWatcher::threadExceptionMessage</a><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>If the watcher thread threw an uncaught exception then its information will be stored here so that the main thread can check whether a watcher encountered an error. </p>
+<p>These are empty strings if everything is OK. </p>
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>Watchdog.cpp</li>
+</ul>
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>