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

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

@@ -0,0 +1,38 @@
+<!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>Client Member List</h1>This is the complete list of members for <a class="el" href="classClient.html">Client</a>, including all inherited members.<table>
+  <tr class="memlist"><td><a class="el" href="classClient.html#a975a3a3d2a4fa5fcf320be38581e99a7">Client</a>(unsigned int number, ApplicationPool::Ptr pool, const string &amp;password, const string &amp;defaultUser, const string &amp;defaultGroup, int serverSocket, const AnalyticsLoggerPtr &amp;logger)</td><td><a class="el" href="classClient.html">Client</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classClient.html#a840e519ca781888cbd54181572ebe3a7">~Client</a>()</td><td><a class="el" href="classClient.html">Client</a></td><td><code> [inline]</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/classClient.html ADDED

@@ -0,0 +1,123 @@
+<!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: Client 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>Client Class Reference</h1><!-- doxytag: class="Client" -->
+<p>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.
+<a href="#_details">More...</a></p>
+<p><a href="classClient-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClient.html#a975a3a3d2a4fa5fcf320be38581e99a7">Client</a> (unsigned int number, ApplicationPool::Ptr pool, const string &amp;password, const string &amp;defaultUser, const string &amp;defaultGroup, int serverSocket, const AnalyticsLoggerPtr &amp;logger)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a client handler for the server with the given arguments and runs it in its own thread.  <a href="#a975a3a3d2a4fa5fcf320be38581e99a7"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a840e519ca781888cbd54181572ebe3a7"></a><!-- doxytag: member="Client::~Client" ref="a840e519ca781888cbd54181572ebe3a7" args="()" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClient.html#a840e519ca781888cbd54181572ebe3a7">~Client</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys this client and its thread. <br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>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. </p>
+<p>This class contains the methods used to communicate from a server to a connected client, i.e. it is a client handler. These <a class="el" href="classClient.html" title="A representation of a Client from the Server&#39;s point of view.">Client</a> instances will communicate concurrently with the server through threads. Considering the overhead of these threads, i.e. setup and teardown costs and the volatility of client requests, these client instances will be pooled. It is for this reason that the State design pattern has been applied: this class can be considered as being a skeleton implemention whose state --e.g. the client file descriptor-- needs to be provided in order to function properly. </p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a975a3a3d2a4fa5fcf320be38581e99a7"></a><!-- doxytag: member="Client::Client" ref="a975a3a3d2a4fa5fcf320be38581e99a7" args="(unsigned int number, ApplicationPool::Ptr pool, const string &amp;password, const string &amp;defaultUser, const string &amp;defaultGroup, int serverSocket, const AnalyticsLoggerPtr &amp;logger)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Client::Client </td>
+          <td>(</td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>number</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">ApplicationPool::Ptr&nbsp;</td>
+          <td class="paramname"> <em>pool</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>password</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>defaultUser</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>defaultGroup</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&nbsp;</td>
+          <td class="paramname"> <em>serverSocket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const AnalyticsLoggerPtr &amp;&nbsp;</td>
+          <td class="paramname"> <em>logger</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Constructs a client handler for the server with the given arguments and runs it in its own thread. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>number</em>&nbsp;</td><td>The id assigned by the server to identify this client by. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>pool</em>&nbsp;</td><td>The application pool where this client belongs to. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>password</em>&nbsp;</td><td>The password that is required to connect to this client handler. This value is determined and assigned by the server. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>serverSocket</em>&nbsp;</td><td>The server socket to accept this clients connection from. </td></tr>
+  </table>
+  </dd>
+</dl>
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>nginx/HelperAgent.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>

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

@@ -0,0 +1,40 @@
+<!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>Hooks Member List</h1>This is the complete list of members for <a class="el" href="classHooks.html">Hooks</a>, including all inherited members.<table>
+  <tr class="memlist"><td><a class="el" href="classHooks.html#a64333270a19c93451c33dcb8fe1666de">saveOriginalFilename</a>(request_rec *r)</td><td><a class="el" href="classHooks.html">Hooks</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classHooks.html#a404c390fa2529611d1c5a15c0bd9f1c3">saveStateBeforeRewriteRules</a>(request_rec *r)</td><td><a class="el" href="classHooks.html">Hooks</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classHooks.html#ad6cca64be8a9075b4b92efdb4d9020a5">startBlockingModAutoIndex</a>(request_rec *r)</td><td><a class="el" href="classHooks.html">Hooks</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classHooks.html#ae3091c57c95b2f8269f566099802f0ec">startBlockingModDir</a>(request_rec *r)</td><td><a class="el" href="classHooks.html">Hooks</a></td><td><code> [inline]</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/classHooks.html ADDED

@@ -0,0 +1,153 @@
+<!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: Hooks 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>Hooks Class Reference<br/>
+<small>
+[<a class="el" href="group__Core.html">Core Apache-related classes and functions</a>]</small>
+</h1><!-- doxytag: class="Hooks" -->
+<p>Apache hook functions, wrapped in a class.
+<a href="#_details">More...</a></p>
+<p><a href="classHooks-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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHooks.html#a64333270a19c93451c33dcb8fe1666de">saveOriginalFilename</a> (request_rec *r)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is the hook method for the map_to_storage hook.  <a href="#a64333270a19c93451c33dcb8fe1666de"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHooks.html#a404c390fa2529611d1c5a15c0bd9f1c3">saveStateBeforeRewriteRules</a> (request_rec *r)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default .htaccess provided by on Rails on Rails (that is, before version 2.1.0) has the following mod_rewrite rules in it:.  <a href="#a404c390fa2529611d1c5a15c0bd9f1c3"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHooks.html#ae3091c57c95b2f8269f566099802f0ec">startBlockingModDir</a> (request_rec *r)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mod_dir does the following: If r-&gt;filename is a directory, and the URI doesn't end with a slash, then it will redirect the browser to an URI with a slash.  <a href="#ae3091c57c95b2f8269f566099802f0ec"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHooks.html#ad6cca64be8a9075b4b92efdb4d9020a5">startBlockingModAutoIndex</a> (request_rec *r)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mod_autoindex will try to display a directory index for URIs that map to a directory.  <a href="#ad6cca64be8a9075b4b92efdb4d9020a5"></a><br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Apache hook functions, wrapped in a class. </p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a64333270a19c93451c33dcb8fe1666de"></a><!-- doxytag: member="Hooks::saveOriginalFilename" ref="a64333270a19c93451c33dcb8fe1666de" args="(request_rec *r)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Hooks::saveOriginalFilename </td>
+          <td>(</td>
+          <td class="paramtype">request_rec *&nbsp;</td>
+          <td class="paramname"> <em>r</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>This is the hook method for the map_to_storage hook. </p>
+<p>Apache's final map_to_storage hook method (defined in core.c) will do the following:</p>
+<p>If r-&gt;filename doesn't exist, then it will change the filename to the following form:</p>
+<p>A/B</p>
+<p>A is top-most directory that exists. B is the first filename piece that normally follows A. For example, suppose that a website's DocumentRoot is /website, on server <a href="http://test.com/.">http://test.com/.</a> Suppose that there's also a directory /website/images. No other files or directories exist in /website.</p>
+<p>If we access: then r-&gt;filename will be: <a href="http://test.com/foo/bar">http://test.com/foo/bar</a> /website/foo <a href="http://test.com/foo/bar/baz">http://test.com/foo/bar/baz</a> /website/foo <a href="http://test.com/images/foo/bar">http://test.com/images/foo/bar</a> /website/images/foo</p>
+<p>We obviously don't want this to happen because it'll interfere with our page cache file search code. So here we save the original value of r-&gt;filename so that we can use it later. </p>
+</div>
+</div>
+<a class="anchor" id="a404c390fa2529611d1c5a15c0bd9f1c3"></a><!-- doxytag: member="Hooks::saveStateBeforeRewriteRules" ref="a404c390fa2529611d1c5a15c0bd9f1c3" args="(request_rec *r)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Hooks::saveStateBeforeRewriteRules </td>
+          <td>(</td>
+          <td class="paramtype">request_rec *&nbsp;</td>
+          <td class="paramname"> <em>r</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>The default .htaccess provided by on Rails on Rails (that is, before version 2.1.0) has the following mod_rewrite rules in it:. </p>
+<p>RewriteEngine on RewriteRule ^$ index.html [QSA] RewriteRule ^([^.]+)$ $1.html [QSA] RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^(.*)$ dispatch.cgi [QSA,L]</p>
+<p>As a result, all requests that do not map to a filename will be redirected to dispatch.cgi (or dispatch.fcgi, if the user so specified). We don't want that to happen, so before mod_rewrite applies its rules, we save the current state. After mod_rewrite has applied its rules, undoRedirectionToDispatchCgi() will check whether mod_rewrite attempted to perform an internal redirection to dispatch.(f)cgi. If so, then it will revert the state to the way it was before mod_rewrite took place. </p>
+</div>
+</div>
+<a class="anchor" id="ad6cca64be8a9075b4b92efdb4d9020a5"></a><!-- doxytag: member="Hooks::startBlockingModAutoIndex" ref="ad6cca64be8a9075b4b92efdb4d9020a5" args="(request_rec *r)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Hooks::startBlockingModAutoIndex </td>
+          <td>(</td>
+          <td class="paramtype">request_rec *&nbsp;</td>
+          <td class="paramname"> <em>r</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>mod_autoindex will try to display a directory index for URIs that map to a directory. </p>
+<p>This is undesired because of page caching semantics. Suppose that a Rails application has an ImagesController which has page caching enabled, and thus also a 'public/images' directory. When the visitor visits /images we'll want the request to be forwarded to the Rails application, instead of displaying a directory index.</p>
+<p>So in this hook method, we temporarily change some fields in the request structure in order to block mod_autoindex. In endBlockingModAutoIndex(), we restore the request structure to its former state. </p>
+</div>
+</div>
+<a class="anchor" id="ae3091c57c95b2f8269f566099802f0ec"></a><!-- doxytag: member="Hooks::startBlockingModDir" ref="ae3091c57c95b2f8269f566099802f0ec" args="(request_rec *r)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Hooks::startBlockingModDir </td>
+          <td>(</td>
+          <td class="paramtype">request_rec *&nbsp;</td>
+          <td class="paramname"> <em>r</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>mod_dir does the following: If r-&gt;filename is a directory, and the URI doesn't end with a slash, then it will redirect the browser to an URI with a slash. </p>
+<p>For example, if you go to <a href="http://foo.com/images,">http://foo.com/images,</a> then it will redirect you to <a href="http://foo.com/images/.">http://foo.com/images/.</a></p>
+<p>This behavior is undesired. Suppose that there is an ImagesController, and there's also a 'public/images' folder used for storing page cache files. Then we don't want mod_dir to perform the redirection.</p>
+<p>So in <a class="el" href="classHooks.html#ae3091c57c95b2f8269f566099802f0ec" title="mod_dir does the following: If r-&gt;filename is a directory, and the URI doesn&#39;t...">startBlockingModDir()</a>, we temporarily change some fields in the request structure in order to block mod_dir. In endBlockingModDir() we revert those fields to their old value. </p>
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>Hooks.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>

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

@@ -0,0 +1,40 @@
+<!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>Passenger::AbstractSpawnManager Member List</h1>This is the complete list of members for <a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a>, including all inherited members.<table>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html#aa630e8c364f391b54c0bfb723326836a">getServerPid</a>() const =0</td><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a></td><td><code> [pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html#a225574ef363847058554fde9d5704950">killSpawnServer</a>() const =0</td><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a></td><td><code> [pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html#a5043681dbfb9b77fa0679c510ede853c">reload</a>(const string &amp;appRoot)=0</td><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a></td><td><code> [pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html#a6ca7efc68595bf962f5cce5e6407f176">spawn</a>(const PoolOptions &amp;options)=0</td><td><a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a></td><td><code> [pure virtual]</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/classPassenger_1_1AbstractSpawnManager.html ADDED

@@ -0,0 +1,187 @@
+<!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: Passenger::AbstractSpawnManager 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 class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1AbstractSpawnManager.html">AbstractSpawnManager</a>
+  </div>
+</div>
+<div class="contents">
+<h1>Passenger::AbstractSpawnManager Class Reference<br/>
+<small>
+[<a class="el" href="group__Support.html">Apache-independent support classes and function</a>]</small>
+</h1><!-- doxytag: class="Passenger::AbstractSpawnManager" -->
+<p>Spawning of application processes.
+<a href="#_details">More...</a></p>
+<p><code>#include &lt;<a class="el" href="AbstractSpawnManager_8h_source.html">AbstractSpawnManager.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for Passenger::AbstractSpawnManager:</div>
+<div class="dynsection">
+<div class="center"><img src="classPassenger_1_1AbstractSpawnManager__inherit__graph.png" border="0" usemap="#Passenger_1_1AbstractSpawnManager_inherit__map" alt="Inheritance graph"/></div>
+<map name="Passenger_1_1AbstractSpawnManager_inherit__map" id="Passenger_1_1AbstractSpawnManager_inherit__map">
+<area shape="rect" id="node3" href="classPassenger_1_1SpawnManager.html" title="An AbstractSpawnManager implementation." alt="" coords="32,83,227,112"/></map>
+<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
+<p><a href="classPassenger_1_1AbstractSpawnManager-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 <a class="el" href="namespacePassenger.html#aced1f248465136b313c6dec5fe6ca492">ProcessPtr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1AbstractSpawnManager.html#a6ca7efc68595bf962f5cce5e6407f176">spawn</a> (const <a class="el" href="structPassenger_1_1PoolOptions.html">PoolOptions</a> &amp;options)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Spawn a new application process.  <a href="#a6ca7efc68595bf962f5cce5e6407f176"></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="classPassenger_1_1AbstractSpawnManager.html#a5043681dbfb9b77fa0679c510ede853c">reload</a> (const string &amp;appRoot)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shutdown the ApplicationSpawner server that's running at the given application root.  <a href="#a5043681dbfb9b77fa0679c510ede853c"></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="classPassenger_1_1AbstractSpawnManager.html#a225574ef363847058554fde9d5704950">killSpawnServer</a> () const =0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forcefully kill the spawn server.  <a href="#a225574ef363847058554fde9d5704950"></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="classPassenger_1_1AbstractSpawnManager.html#aa630e8c364f391b54c0bfb723326836a">getServerPid</a> () const =0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the spawn server's PID.  <a href="#aa630e8c364f391b54c0bfb723326836a"></a><br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Spawning of application processes. </p>
+<p>An <a class="el" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> is responsible for spawning new application processes. Use the <a class="el" href="classPassenger_1_1AbstractSpawnManager.html#a6ca7efc68595bf962f5cce5e6407f176" title="Spawn a new application process.">spawn()</a> method to do so. <a class="el" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> is guaranteed to be thread-safe.</p>
+<p><a class="el" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> is just an interface. There are two concrete implementations, namely <a class="el" href="classPassenger_1_1SpawnManager.html" title="An AbstractSpawnManager implementation.">SpawnManager</a> and StubSpawnManager. The former is the one that's usually used, while the latter exists for unit testing purposes. </p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="aa630e8c364f391b54c0bfb723326836a"></a><!-- doxytag: member="Passenger::AbstractSpawnManager::getServerPid" ref="aa630e8c364f391b54c0bfb723326836a" args="() const =0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual pid_t Passenger::AbstractSpawnManager::getServerPid </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 spawn server's PID. </p>
+<p>Used within unit tests. </p>
+<p>Implemented in <a class="el" href="classPassenger_1_1SpawnManager.html#af34df8cfccfc64507999f1b48bc5a126">Passenger::SpawnManager</a>.</p>
+</div>
+</div>
+<a class="anchor" id="a225574ef363847058554fde9d5704950"></a><!-- doxytag: member="Passenger::AbstractSpawnManager::killSpawnServer" ref="a225574ef363847058554fde9d5704950" args="() const =0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void Passenger::AbstractSpawnManager::killSpawnServer </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>Forcefully kill the spawn server. </p>
+<p>This AbstractSpawnManager's state will not be modified, so that it won't know that the spawn server is killed until next time it sends a command to it.</p>
+<p>Used within unit tests. </p>
+<p>Implemented in <a class="el" href="classPassenger_1_1SpawnManager.html#a9210212c23c5a8ee5ee4dd5c9dcdf57d">Passenger::SpawnManager</a>.</p>
+</div>
+</div>
+<a class="anchor" id="a5043681dbfb9b77fa0679c510ede853c"></a><!-- doxytag: member="Passenger::AbstractSpawnManager::reload" ref="a5043681dbfb9b77fa0679c510ede853c" args="(const string &amp;appRoot)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void Passenger::AbstractSpawnManager::reload </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>appRoot</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Shutdown the ApplicationSpawner server that's running at the given application root. </p>
+<p>This method should be called when it's time to reload an application.</p>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Unable to communicate with the spawn server, even after a restart. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fails to spawn an application instance...">SpawnException</a></em>&nbsp;</td><td>The spawn server died unexpectedly, and a restart was attempted, but it failed. </td></tr>
+  </table>
+  </dd>
+</dl>
+<p>Implemented in <a class="el" href="classPassenger_1_1SpawnManager.html#aad71b2ea9431f3286f23a6e6f80e0981">Passenger::SpawnManager</a>.</p>
+</div>
+</div>
+<a class="anchor" id="a6ca7efc68595bf962f5cce5e6407f176"></a><!-- doxytag: member="Passenger::AbstractSpawnManager::spawn" ref="a6ca7efc68595bf962f5cce5e6407f176" args="(const PoolOptions &amp;options)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual <a class="el" href="namespacePassenger.html#aced1f248465136b313c6dec5fe6ca492">ProcessPtr</a> Passenger::AbstractSpawnManager::spawn </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="structPassenger_1_1PoolOptions.html">PoolOptions</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>options</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Spawn a new application process. </p>
+<p>Spawning details are to be passed via the <code>options</code> argument.</p>
+<p>If the spawn server died during the spawning process, then the server will be automatically restarted, and another spawn attempt will be made. If restarting the server fails, or if the second spawn attempt fails, then an exception will be thrown.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>options</em>&nbsp;</td><td>An object containing the details for this spawn operation, such as which application to spawn. See <a class="el" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a> for details. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>A smart pointer to a <a class="el" href="classPassenger_1_1Process.html" title="Represents a single application process, as spawned by SpawnManager or by ApplicationPool::Interface...">Process</a> object, which represents the application process that has been spawned. Use this object to communicate with the spawned process. </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><a class="el" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fails to spawn an application instance...">SpawnException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>Anything</em>&nbsp;</td><td>thrown by options.environmentVariables-&gt;getItems(). </td></tr>
+  </table>
+  </dd>
+</dl>
+<p>Implemented in <a class="el" href="classPassenger_1_1SpawnManager.html#a88a94ba4d41dab492cb1dc8a0f998973">Passenger::SpawnManager</a>.</p>
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="AbstractSpawnManager_8h_source.html">AbstractSpawnManager.h</a></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>