passenger 2.0.6 → 2.1.2

data/doc/cxxapi/ApplicationPool_8h-source.html

@@ -10,7 +10,6 @@
     <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>
@@ -41,183 +40,181 @@
 <a name="l00024"></a>00024 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
 <a name="l00025"></a>00025 
 <a name="l00026"></a>00026 <span class="preprocessor">#include "Application.h"</span>
-<a name="l00027"></a>00027 
-<a name="l00028"></a>00028 <span class="keyword">namespace </span>Passenger {
-<a name="l00029"></a>00029 
-<a name="l00030"></a>00030 <span class="keyword">using namespace </span>std;
-<a name="l00031"></a>00031 <span class="keyword">using namespace </span>boost;
-<a name="l00032"></a>00032 <span class="comment"></span>
-<a name="l00033"></a>00033 <span class="comment">/**</span>
-<a name="l00034"></a>00034 <span class="comment"> * A persistent pool of Applications.</span>
-<a name="l00035"></a>00035 <span class="comment"> *</span>
-<a name="l00036"></a>00036 <span class="comment"> * Spawning application instances, especially Ruby on Rails ones, is a very expensive operation.</span>
-<a name="l00037"></a>00037 <span class="comment"> * Despite best efforts to make the operation less expensive (see SpawnManager),</span>
-<a name="l00038"></a>00038 <span class="comment"> * it remains expensive compared to the cost of processing an HTTP request/response.</span>
-<a name="l00039"></a>00039 <span class="comment"> * So, in order to solve this, some sort of caching/pooling mechanism will be required.</span>
-<a name="l00040"></a>00040 <span class="comment"> * ApplicationPool provides this.</span>
-<a name="l00041"></a>00041 <span class="comment"> *</span>
-<a name="l00042"></a>00042 <span class="comment"> * Normally, one would use SpawnManager to spawn a new RoR/Rack application instance,</span>
-<a name="l00043"></a>00043 <span class="comment"> * then use Application::connect() to create a new session with that application</span>
-<a name="l00044"></a>00044 <span class="comment"> * instance, and then use the returned Session object to send the request and</span>
-<a name="l00045"></a>00045 <span class="comment"> * to read the HTTP response. ApplicationPool replaces the first step with</span>
-<a name="l00046"></a>00046 <span class="comment"> * a call to Application::get(). For example:</span>
-<a name="l00047"></a>00047 <span class="comment"> * @code</span>
-<a name="l00048"></a>00048 <span class="comment"> *   ApplicationPool pool = some_function_which_creates_an_application_pool();</span>
-<a name="l00049"></a>00049 <span class="comment"> *   </span>
-<a name="l00050"></a>00050 <span class="comment"> *   // Connect to the application and get the newly opened session.</span>
-<a name="l00051"></a>00051 <span class="comment"> *   Application::SessionPtr session(pool-&gt;get("/home/webapps/foo"));</span>
-<a name="l00052"></a>00052 <span class="comment"> *   </span>
-<a name="l00053"></a>00053 <span class="comment"> *   // Send the request headers and request body data.</span>
-<a name="l00054"></a>00054 <span class="comment"> *   session-&gt;sendHeaders(...);</span>
-<a name="l00055"></a>00055 <span class="comment"> *   session-&gt;sendBodyBlock(...);</span>
-<a name="l00056"></a>00056 <span class="comment"> *   // Done sending data, so we shutdown the writer stream.</span>
-<a name="l00057"></a>00057 <span class="comment"> *   session-&gt;shutdownWriter();</span>
-<a name="l00058"></a>00058 <span class="comment"> *</span>
-<a name="l00059"></a>00059 <span class="comment"> *   // Now read the HTTP response.</span>
-<a name="l00060"></a>00060 <span class="comment"> *   string responseData = readAllDataFromSocket(session-&gt;getStream());</span>
-<a name="l00061"></a>00061 <span class="comment"> *   // Done reading data, so we shutdown the reader stream.</span>
-<a name="l00062"></a>00062 <span class="comment"> *   session-&gt;shutdownReader();</span>
-<a name="l00063"></a>00063 <span class="comment"> *</span>
-<a name="l00064"></a>00064 <span class="comment"> *   // This session has now finished, so we close the session by resetting</span>
-<a name="l00065"></a>00065 <span class="comment"> *   // the smart pointer to NULL (thereby destroying the Session object).</span>
-<a name="l00066"></a>00066 <span class="comment"> *   session.reset();</span>
-<a name="l00067"></a>00067 <span class="comment"> *</span>
-<a name="l00068"></a>00068 <span class="comment"> *   // We can connect to an Application multiple times. Just make sure</span>
-<a name="l00069"></a>00069 <span class="comment"> *   // the previous session is closed.</span>
-<a name="l00070"></a>00070 <span class="comment"> *   session = app-&gt;connect("/home/webapps/bar")</span>
-<a name="l00071"></a>00071 <span class="comment"> * @endcode</span>
-<a name="l00072"></a>00072 <span class="comment"> *</span>
-<a name="l00073"></a>00073 <span class="comment"> * Internally, ApplicationPool::get() will keep spawned applications instances in</span>
-<a name="l00074"></a>00074 <span class="comment"> * memory, and reuse them if possible. It wil* @throw l try to keep spawning to a minimum.</span>
-<a name="l00075"></a>00075 <span class="comment"> * Furthermore, if an application instance hasn't been used for a while, it</span>
-<a name="l00076"></a>00076 <span class="comment"> * will be automatically shutdown in order to save memory. Restart requests are</span>
-<a name="l00077"></a>00077 <span class="comment"> * honored: if an application has the file 'restart.txt' in its 'tmp' folder,</span>
-<a name="l00078"></a>00078 <span class="comment"> * then get() will shutdown existing instances of that application and spawn</span>
-<a name="l00079"></a>00079 <span class="comment"> * a new instance (this is useful when a new version of an application has been</span>
-<a name="l00080"></a>00080 <span class="comment"> * deployed). And finally, one can set a hard limit on the maximum number of</span>
-<a name="l00081"></a>00081 <span class="comment"> * applications instances that may be spawned (see ApplicationPool::setMax()).</span>
-<a name="l00082"></a>00082 <span class="comment"> *</span>
-<a name="l00083"></a>00083 <span class="comment"> * Note that ApplicationPool is just an interface (i.e. a pure virtual class).</span>
-<a name="l00084"></a>00084 <span class="comment"> * For concrete classes, see StandardApplicationPool and ApplicationPoolServer.</span>
-<a name="l00085"></a>00085 <span class="comment"> * The exact pooling algorithm depends on the implementation class.</span>
-<a name="l00086"></a>00086 <span class="comment"> *</span>
-<a name="l00087"></a>00087 <span class="comment"> * @ingroup Support</span>
-<a name="l00088"></a>00088 <span class="comment"> */</span>
-<a name="l00089"></a><a class="code" href="classPassenger_1_1ApplicationPool.html">00089</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> {
-<a name="l00090"></a>00090 <span class="keyword">public</span>:
-<a name="l00091"></a>00091         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a>() {};
-<a name="l00092"></a>00092         <span class="comment"></span>
-<a name="l00093"></a>00093 <span class="comment">        /**</span>
-<a name="l00094"></a>00094 <span class="comment">         * Open a new session with the application specified by &lt;tt&gt;appRoot&lt;/tt&gt;.</span>
-<a name="l00095"></a>00095 <span class="comment">         * See the class description for ApplicationPool, as well as Application::connect(),</span>
-<a name="l00096"></a>00096 <span class="comment">         * on how to use the returned session object.</span>
+<a name="l00027"></a>00027 <span class="preprocessor">#include "PoolOptions.h"</span>
+<a name="l00028"></a>00028 
+<a name="l00029"></a>00029 <span class="keyword">namespace </span>Passenger {
+<a name="l00030"></a>00030 
+<a name="l00031"></a>00031 <span class="keyword">using namespace </span>std;
+<a name="l00032"></a>00032 <span class="keyword">using namespace </span>boost;
+<a name="l00033"></a>00033 <span class="comment"></span>
+<a name="l00034"></a>00034 <span class="comment">/**</span>
+<a name="l00035"></a>00035 <span class="comment"> * A persistent pool of Applications.</span>
+<a name="l00036"></a>00036 <span class="comment"> *</span>
+<a name="l00037"></a>00037 <span class="comment"> * Spawning application instances, especially Ruby on Rails ones, is a very expensive operation.</span>
+<a name="l00038"></a>00038 <span class="comment"> * Despite best efforts to make the operation less expensive (see SpawnManager),</span>
+<a name="l00039"></a>00039 <span class="comment"> * it remains expensive compared to the cost of processing an HTTP request/response.</span>
+<a name="l00040"></a>00040 <span class="comment"> * So, in order to solve this, some sort of caching/pooling mechanism will be required.</span>
+<a name="l00041"></a>00041 <span class="comment"> * ApplicationPool provides this.</span>
+<a name="l00042"></a>00042 <span class="comment"> *</span>
+<a name="l00043"></a>00043 <span class="comment"> * Normally, one would use SpawnManager to spawn a new RoR/Rack application instance,</span>
+<a name="l00044"></a>00044 <span class="comment"> * then use Application::connect() to create a new session with that application</span>
+<a name="l00045"></a>00045 <span class="comment"> * instance, and then use the returned Session object to send the request and</span>
+<a name="l00046"></a>00046 <span class="comment"> * to read the HTTP response. ApplicationPool replaces the first step with</span>
+<a name="l00047"></a>00047 <span class="comment"> * a call to Application::get(). For example:</span>
+<a name="l00048"></a>00048 <span class="comment"> * @code</span>
+<a name="l00049"></a>00049 <span class="comment"> *   ApplicationPool pool = some_function_which_creates_an_application_pool();</span>
+<a name="l00050"></a>00050 <span class="comment"> *   </span>
+<a name="l00051"></a>00051 <span class="comment"> *   // Connect to the application and get the newly opened session.</span>
+<a name="l00052"></a>00052 <span class="comment"> *   Application::SessionPtr session(pool-&gt;get("/home/webapps/foo"));</span>
+<a name="l00053"></a>00053 <span class="comment"> *   </span>
+<a name="l00054"></a>00054 <span class="comment"> *   // Send the request headers and request body data.</span>
+<a name="l00055"></a>00055 <span class="comment"> *   session-&gt;sendHeaders(...);</span>
+<a name="l00056"></a>00056 <span class="comment"> *   session-&gt;sendBodyBlock(...);</span>
+<a name="l00057"></a>00057 <span class="comment"> *   // Done sending data, so we shutdown the writer stream.</span>
+<a name="l00058"></a>00058 <span class="comment"> *   session-&gt;shutdownWriter();</span>
+<a name="l00059"></a>00059 <span class="comment"> *</span>
+<a name="l00060"></a>00060 <span class="comment"> *   // Now read the HTTP response.</span>
+<a name="l00061"></a>00061 <span class="comment"> *   string responseData = readAllDataFromSocket(session-&gt;getStream());</span>
+<a name="l00062"></a>00062 <span class="comment"> *   // Done reading data, so we shutdown the reader stream.</span>
+<a name="l00063"></a>00063 <span class="comment"> *   session-&gt;shutdownReader();</span>
+<a name="l00064"></a>00064 <span class="comment"> *</span>
+<a name="l00065"></a>00065 <span class="comment"> *   // This session has now finished, so we close the session by resetting</span>
+<a name="l00066"></a>00066 <span class="comment"> *   // the smart pointer to NULL (thereby destroying the Session object).</span>
+<a name="l00067"></a>00067 <span class="comment"> *   session.reset();</span>
+<a name="l00068"></a>00068 <span class="comment"> *</span>
+<a name="l00069"></a>00069 <span class="comment"> *   // We can connect to an Application multiple times. Just make sure</span>
+<a name="l00070"></a>00070 <span class="comment"> *   // the previous session is closed.</span>
+<a name="l00071"></a>00071 <span class="comment"> *   session = app-&gt;connect("/home/webapps/bar")</span>
+<a name="l00072"></a>00072 <span class="comment"> * @endcode</span>
+<a name="l00073"></a>00073 <span class="comment"> *</span>
+<a name="l00074"></a>00074 <span class="comment"> * Internally, ApplicationPool::get() will keep spawned applications instances in</span>
+<a name="l00075"></a>00075 <span class="comment"> * memory, and reuse them if possible. It wil* @throw l try to keep spawning to a minimum.</span>
+<a name="l00076"></a>00076 <span class="comment"> * Furthermore, if an application instance hasn't been used for a while, it</span>
+<a name="l00077"></a>00077 <span class="comment"> * will be automatically shutdown in order to save memory. Restart requests are</span>
+<a name="l00078"></a>00078 <span class="comment"> * honored: if an application has the file 'restart.txt' in its 'tmp' folder,</span>
+<a name="l00079"></a>00079 <span class="comment"> * then get() will shutdown existing instances of that application and spawn</span>
+<a name="l00080"></a>00080 <span class="comment"> * a new instance (this is useful when a new version of an application has been</span>
+<a name="l00081"></a>00081 <span class="comment"> * deployed). And finally, one can set a hard limit on the maximum number of</span>
+<a name="l00082"></a>00082 <span class="comment"> * applications instances that may be spawned (see ApplicationPool::setMax()).</span>
+<a name="l00083"></a>00083 <span class="comment"> *</span>
+<a name="l00084"></a>00084 <span class="comment"> * Note that ApplicationPool is just an interface (i.e. a pure virtual class).</span>
+<a name="l00085"></a>00085 <span class="comment"> * For concrete classes, see StandardApplicationPool and ApplicationPoolServer.</span>
+<a name="l00086"></a>00086 <span class="comment"> * The exact pooling algorithm depends on the implementation class.</span>
+<a name="l00087"></a>00087 <span class="comment"> *</span>
+<a name="l00088"></a>00088 <span class="comment"> * @ingroup Support</span>
+<a name="l00089"></a>00089 <span class="comment"> */</span>
+<a name="l00090"></a><a class="code" href="classPassenger_1_1ApplicationPool.html">00090</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> {
+<a name="l00091"></a>00091 <span class="keyword">public</span>:
+<a name="l00092"></a>00092         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a>() {};
+<a name="l00093"></a>00093         <span class="comment"></span>
+<a name="l00094"></a>00094 <span class="comment">        /**</span>
+<a name="l00095"></a>00095 <span class="comment">         * Checks whether this ApplicationPool object is still connected to the</span>
+<a name="l00096"></a>00096 <span class="comment">         * ApplicationPool server.</span>
 <a name="l00097"></a>00097 <span class="comment">         *</span>
-<a name="l00098"></a>00098 <span class="comment">         * Internally, this method may either spawn a new application instance, or use</span>
-<a name="l00099"></a>00099 <span class="comment">         * an existing one.</span>
-<a name="l00100"></a>00100 <span class="comment">         *</span>
-<a name="l00101"></a>00101 <span class="comment">         * If &lt;tt&gt;lowerPrivilege&lt;/tt&gt; is true, then any newly spawned application</span>
-<a name="l00102"></a>00102 <span class="comment">         * instances will have lower privileges. See SpawnManager::SpawnManager()'s</span>
-<a name="l00103"></a>00103 <span class="comment">         * description of &lt;tt&gt;lowerPrivilege&lt;/tt&gt; and &lt;tt&gt;lowestUser&lt;/tt&gt; for details.</span>
-<a name="l00104"></a>00104 <span class="comment">         *</span>
-<a name="l00105"></a>00105 <span class="comment">         * @param appRoot The application root of a RoR application, i.e. the folder that</span>
-<a name="l00106"></a>00106 <span class="comment">         *             contains 'app/', 'public/', 'config/', etc. This must be a valid</span>
-<a name="l00107"></a>00107 <span class="comment">         *             directory, but does not have to be an absolute path.</span>
-<a name="l00108"></a>00108 <span class="comment">         * @param lowerPrivilege Whether to lower the application's privileges.</span>
-<a name="l00109"></a>00109 <span class="comment">         * @param lowestUser The user to fallback to if lowering privilege fails.</span>
-<a name="l00110"></a>00110 <span class="comment">         * @param environment The RAILS_ENV/RACK_ENV environment that should be used. May not be empty.</span>
-<a name="l00111"></a>00111 <span class="comment">         * @param spawnMethod The spawn method to use. Either "smart" or "conservative".</span>
-<a name="l00112"></a>00112 <span class="comment">         *                    See the Ruby class SpawnManager for details.</span>
-<a name="l00113"></a>00113 <span class="comment">         * @param appType The application type. Either "rails" or "rack".</span>
-<a name="l00114"></a>00114 <span class="comment">         * @return A session object.</span>
-<a name="l00115"></a>00115 <span class="comment">         * @throw SpawnException An attempt was made to spawn a new application instance, but that attempt failed.</span>
-<a name="l00116"></a>00116 <span class="comment">         * @throw BusyException The application pool is too busy right now, and cannot</span>
-<a name="l00117"></a>00117 <span class="comment">         *       satisfy the request. One should either abort, or try again later.</span>
-<a name="l00118"></a>00118 <span class="comment">         * @throw IOException Something else went wrong.</span>
-<a name="l00119"></a>00119 <span class="comment">         * @throw thread_interrupted</span>
-<a name="l00120"></a>00120 <span class="comment">         * @note Applications are uniquely identified with the application root</span>
-<a name="l00121"></a>00121 <span class="comment">         *       string. So although &lt;tt&gt;appRoot&lt;/tt&gt; does not have to be absolute, it</span>
-<a name="l00122"></a>00122 <span class="comment">         *       should be. If one calls &lt;tt&gt;get("/home/foo")&lt;/tt&gt; and</span>
-<a name="l00123"></a>00123 <span class="comment">         *       &lt;tt&gt;get("/home/../home/foo")&lt;/tt&gt;, then ApplicationPool will think</span>
-<a name="l00124"></a>00124 <span class="comment">         *       they're 2 different applications, and thus will spawn 2 application instances.</span>
-<a name="l00125"></a>00125 <span class="comment">         */</span>
-<a name="l00126"></a>00126         <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;appRoot, <span class="keywordtype">bool</span> lowerPrivilege = <span class="keyword">true</span>,
-<a name="l00127"></a>00127                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;lowestUser = <span class="stringliteral">"nobody"</span>, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;environment = <span class="stringliteral">"production"</span>,
-<a name="l00128"></a>00128                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;spawnMethod = <span class="stringliteral">"smart"</span>, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;appType = <span class="stringliteral">"rails"</span>) = 0;
-<a name="l00129"></a>00129         <span class="comment"></span>
-<a name="l00130"></a>00130 <span class="comment">        /**</span>
-<a name="l00131"></a>00131 <span class="comment">         * Clear all application instances that are currently in the pool.</span>
-<a name="l00132"></a>00132 <span class="comment">         *</span>
-<a name="l00133"></a>00133 <span class="comment">         * This method is used by unit tests to verify that the implementation is correct,</span>
-<a name="l00134"></a>00134 <span class="comment">         * and thus should not be called directly.</span>
+<a name="l00098"></a>00098 <span class="comment">         * If that's not the case, then one should reconnect to the ApplicationPool server.</span>
+<a name="l00099"></a>00099 <span class="comment">         *</span>
+<a name="l00100"></a>00100 <span class="comment">         * This method is only meaningful for instances of type ApplicationPoolServer::Client.</span>
+<a name="l00101"></a>00101 <span class="comment">         * The default implementation always returns true.</span>
+<a name="l00102"></a>00102 <span class="comment">         */</span>
+<a name="l00103"></a><a class="code" href="classPassenger_1_1ApplicationPool.html#c811d261345fcf579f049a2377b4b56b">00103</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#c811d261345fcf579f049a2377b4b56b" title="Checks whether this ApplicationPool object is still connected to the ApplicationPool...">connected</a>()<span class="keyword"> const </span>{
+<a name="l00104"></a>00104                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00105"></a>00105         }
+<a name="l00106"></a>00106         <span class="comment"></span>
+<a name="l00107"></a>00107 <span class="comment">        /**</span>
+<a name="l00108"></a>00108 <span class="comment">         * Open a new session with the application specified by &lt;tt&gt;PoolOptions.appRoot&lt;/tt&gt;.</span>
+<a name="l00109"></a>00109 <span class="comment">         * See the class description for ApplicationPool, as well as Application::connect(),</span>
+<a name="l00110"></a>00110 <span class="comment">         * on how to use the returned session object.</span>
+<a name="l00111"></a>00111 <span class="comment">         *</span>
+<a name="l00112"></a>00112 <span class="comment">         * Internally, this method may either spawn a new application instance, or use</span>
+<a name="l00113"></a>00113 <span class="comment">         * an existing one.</span>
+<a name="l00114"></a>00114 <span class="comment">         *</span>
+<a name="l00115"></a>00115 <span class="comment">         * @param options An object containing information on which application to open</span>
+<a name="l00116"></a>00116 <span class="comment">         *             a session with, as well as spawning details. Spawning details will be used</span>
+<a name="l00117"></a>00117 <span class="comment">         *             if the pool decides that spawning a new application instance is necessary.</span>
+<a name="l00118"></a>00118 <span class="comment">         *             See SpawnManager and PoolOptions for details.</span>
+<a name="l00119"></a>00119 <span class="comment">         * @return A session object.</span>
+<a name="l00120"></a>00120 <span class="comment">         * @throw SpawnException An attempt was made to spawn a new application instance, but that attempt failed.</span>
+<a name="l00121"></a>00121 <span class="comment">         * @throw BusyException The application pool is too busy right now, and cannot</span>
+<a name="l00122"></a>00122 <span class="comment">         *       satisfy the request. One should either abort, or try again later.</span>
+<a name="l00123"></a>00123 <span class="comment">         * @throw IOException Something else went wrong.</span>
+<a name="l00124"></a>00124 <span class="comment">         * @throw thread_interrupted</span>
+<a name="l00125"></a>00125 <span class="comment">         * @note Applications are uniquely identified with the application root</span>
+<a name="l00126"></a>00126 <span class="comment">         *       string. So although &lt;tt&gt;appRoot&lt;/tt&gt; does not have to be absolute, it</span>
+<a name="l00127"></a>00127 <span class="comment">         *       should be. If one calls &lt;tt&gt;get("/home/foo")&lt;/tt&gt; and</span>
+<a name="l00128"></a>00128 <span class="comment">         *       &lt;tt&gt;get("/home/../home/foo")&lt;/tt&gt;, then ApplicationPool will think</span>
+<a name="l00129"></a>00129 <span class="comment">         *       they're 2 different applications, and thus will spawn 2 application instances.</span>
+<a name="l00130"></a>00130 <span class="comment">         */</span>
+<a name="l00131"></a>00131         <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> <span class="keyword">get</span>(<span class="keyword">const</span> <a class="code" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a> &amp;options) = 0;
+<a name="l00132"></a>00132         <span class="comment"></span>
+<a name="l00133"></a>00133 <span class="comment">        /**</span>
+<a name="l00134"></a>00134 <span class="comment">         * Convenience shortcut for calling get() with default spawn options.</span>
 <a name="l00135"></a>00135 <span class="comment">         */</span>
-<a name="l00136"></a>00136         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#74db4d7a693d45b16320b2296a0c0997" title="Clear all application instances that are currently in the pool.">clear</a>() = 0;
-<a name="l00137"></a>00137         
-<a name="l00138"></a>00138         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setMaxIdleTime(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seconds) = 0;
+<a name="l00136"></a><a class="code" href="classPassenger_1_1ApplicationPool.html#b5cc9a7f0c1e7acb9d5815d4420e25ea">00136</a>         <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;appRoot) {
+<a name="l00137"></a>00137                 <span class="keywordflow">return</span> <span class="keyword">get</span>(<a class="code" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a>(appRoot));
+<a name="l00138"></a>00138         }
 <a name="l00139"></a>00139         <span class="comment"></span>
 <a name="l00140"></a>00140 <span class="comment">        /**</span>
-<a name="l00141"></a>00141 <span class="comment">         * Set a hard limit on the number of application instances that this ApplicationPool</span>
-<a name="l00142"></a>00142 <span class="comment">         * may spawn. The exact behavior depends on the used algorithm, and is not specified by</span>
-<a name="l00143"></a>00143 <span class="comment">         * these API docs.</span>
-<a name="l00144"></a>00144 <span class="comment">         *</span>
-<a name="l00145"></a>00145 <span class="comment">         * It is allowed to set a limit lower than the current number of spawned applications.</span>
-<a name="l00146"></a>00146 <span class="comment">         */</span>
-<a name="l00147"></a>00147         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#0e0f21972ab130c9c0f90c2212328794" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max) = 0;
-<a name="l00148"></a>00148         <span class="comment"></span>
-<a name="l00149"></a>00149 <span class="comment">        /**</span>
-<a name="l00150"></a>00150 <span class="comment">         * Get the number of active applications in the pool.</span>
-<a name="l00151"></a>00151 <span class="comment">         *</span>
-<a name="l00152"></a>00152 <span class="comment">         * This method exposes an implementation detail of the underlying pooling algorithm.</span>
-<a name="l00153"></a>00153 <span class="comment">         * It is used by unit tests to verify that the implementation is correct,</span>
-<a name="l00154"></a>00154 <span class="comment">         * and thus should not be called directly.</span>
-<a name="l00155"></a>00155 <span class="comment">         */</span>
-<a name="l00156"></a>00156         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#06d1eae044d4d761ce77cf09049df8c8" title="Get the number of active applications in the pool.">getActive</a>() <span class="keyword">const</span> = 0;
-<a name="l00157"></a>00157         <span class="comment"></span>
-<a name="l00158"></a>00158 <span class="comment">        /**</span>
-<a name="l00159"></a>00159 <span class="comment">         * Get the number of active applications in the pool.</span>
-<a name="l00160"></a>00160 <span class="comment">         *</span>
-<a name="l00161"></a>00161 <span class="comment">         * This method exposes an implementation detail of the underlying pooling algorithm.</span>
-<a name="l00162"></a>00162 <span class="comment">         * It is used by unit tests to verify that the implementation is correct,</span>
-<a name="l00163"></a>00163 <span class="comment">         * and thus should not be called directly.</span>
-<a name="l00164"></a>00164 <span class="comment">         */</span>
-<a name="l00165"></a>00165         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#93b0277beb510855f85fee5de5c369bb" title="Get the number of active applications in the pool.">getCount</a>() <span class="keyword">const</span> = 0;
-<a name="l00166"></a>00166         <span class="comment"></span>
-<a name="l00167"></a>00167 <span class="comment">        /**</span>
-<a name="l00168"></a>00168 <span class="comment">         * Set a hard limit on the number of application instances that a single application</span>
-<a name="l00169"></a>00169 <span class="comment">         * may spawn in this ApplicationPool. The exact behavior depends on the used algorithm, </span>
-<a name="l00170"></a>00170 <span class="comment">         * and is not specified by these API docs.</span>
-<a name="l00171"></a>00171 <span class="comment">         *</span>
-<a name="l00172"></a>00172 <span class="comment">         * It is allowed to set a limit lower than the current number of spawned applications.</span>
-<a name="l00173"></a>00173 <span class="comment">         */</span>
-<a name="l00174"></a>00174         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#b0437434c79b5444ac0faf768f1410e8" title="Set a hard limit on the number of application instances that a single application...">setMaxPerApp</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max) = 0;
-<a name="l00175"></a>00175         <span class="comment"></span>
-<a name="l00176"></a>00176 <span class="comment">        /**</span>
-<a name="l00177"></a>00177 <span class="comment">         * Sets whether to use a global queue instead of a per-backend process</span>
-<a name="l00178"></a>00178 <span class="comment">         * queue. If enabled, when all backend processes are active, get() will</span>
-<a name="l00179"></a>00179 <span class="comment">         * wait until there's at least one backend process that's idle, instead</span>
-<a name="l00180"></a>00180 <span class="comment">         * of queuing the request into a random process's private queue.</span>
-<a name="l00181"></a>00181 <span class="comment">         * This is especially useful if a website has one or more long-running</span>
-<a name="l00182"></a>00182 <span class="comment">         * requests.</span>
-<a name="l00183"></a>00183 <span class="comment">         *</span>
-<a name="l00184"></a>00184 <span class="comment">         * Defaults to false.</span>
-<a name="l00185"></a>00185 <span class="comment">         */</span>
-<a name="l00186"></a>00186         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#b5faf64421313e1387c187f80b95d0e7" title="Sets whether to use a global queue instead of a per-backend process queue.">setUseGlobalQueue</a>(<span class="keywordtype">bool</span> value) = 0;
-<a name="l00187"></a>00187         <span class="comment"></span>
-<a name="l00188"></a>00188 <span class="comment">        /**</span>
-<a name="l00189"></a>00189 <span class="comment">         * Get the process ID of the spawn server that is used.</span>
-<a name="l00190"></a>00190 <span class="comment">         *</span>
-<a name="l00191"></a>00191 <span class="comment">         * This method exposes an implementation detail. It is used by unit tests to verify</span>
-<a name="l00192"></a>00192 <span class="comment">         * that the implementation is correct, and thus should not be used directly.</span>
-<a name="l00193"></a>00193 <span class="comment">         */</span>
-<a name="l00194"></a>00194         <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1ApplicationPool.html#d9149c3b434ef8e18fd15a77af1a6c2c" title="Get the process ID of the spawn server that is used.">getSpawnServerPid</a>() <span class="keyword">const</span> = 0;
-<a name="l00195"></a>00195 };
+<a name="l00141"></a>00141 <span class="comment">         * Clear all application instances that are currently in the pool.</span>
+<a name="l00142"></a>00142 <span class="comment">         *</span>
+<a name="l00143"></a>00143 <span class="comment">         * This method is used by unit tests to verify that the implementation is correct,</span>
+<a name="l00144"></a>00144 <span class="comment">         * and thus should not be called directly.</span>
+<a name="l00145"></a>00145 <span class="comment">         */</span>
+<a name="l00146"></a>00146         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#74db4d7a693d45b16320b2296a0c0997" title="Clear all application instances that are currently in the pool.">clear</a>() = 0;
+<a name="l00147"></a>00147         
+<a name="l00148"></a>00148         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setMaxIdleTime(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seconds) = 0;
+<a name="l00149"></a>00149         <span class="comment"></span>
+<a name="l00150"></a>00150 <span class="comment">        /**</span>
+<a name="l00151"></a>00151 <span class="comment">         * Set a hard limit on the number of application instances that this ApplicationPool</span>
+<a name="l00152"></a>00152 <span class="comment">         * may spawn. The exact behavior depends on the used algorithm, and is not specified by</span>
+<a name="l00153"></a>00153 <span class="comment">         * these API docs.</span>
+<a name="l00154"></a>00154 <span class="comment">         *</span>
+<a name="l00155"></a>00155 <span class="comment">         * It is allowed to set a limit lower than the current number of spawned applications.</span>
+<a name="l00156"></a>00156 <span class="comment">         */</span>
+<a name="l00157"></a>00157         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#0e0f21972ab130c9c0f90c2212328794" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max) = 0;
+<a name="l00158"></a>00158         <span class="comment"></span>
+<a name="l00159"></a>00159 <span class="comment">        /**</span>
+<a name="l00160"></a>00160 <span class="comment">         * Get the number of active applications in the pool.</span>
+<a name="l00161"></a>00161 <span class="comment">         *</span>
+<a name="l00162"></a>00162 <span class="comment">         * This method exposes an implementation detail of the underlying pooling algorithm.</span>
+<a name="l00163"></a>00163 <span class="comment">         * It is used by unit tests to verify that the implementation is correct,</span>
+<a name="l00164"></a>00164 <span class="comment">         * and thus should not be called directly.</span>
+<a name="l00165"></a>00165 <span class="comment">         */</span>
+<a name="l00166"></a>00166         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#06d1eae044d4d761ce77cf09049df8c8" title="Get the number of active applications in the pool.">getActive</a>() <span class="keyword">const</span> = 0;
+<a name="l00167"></a>00167         <span class="comment"></span>
+<a name="l00168"></a>00168 <span class="comment">        /**</span>
+<a name="l00169"></a>00169 <span class="comment">         * Get the number of active applications in the pool.</span>
+<a name="l00170"></a>00170 <span class="comment">         *</span>
+<a name="l00171"></a>00171 <span class="comment">         * This method exposes an implementation detail of the underlying pooling algorithm.</span>
+<a name="l00172"></a>00172 <span class="comment">         * It is used by unit tests to verify that the implementation is correct,</span>
+<a name="l00173"></a>00173 <span class="comment">         * and thus should not be called directly.</span>
+<a name="l00174"></a>00174 <span class="comment">         */</span>
+<a name="l00175"></a>00175         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#93b0277beb510855f85fee5de5c369bb" title="Get the number of active applications in the pool.">getCount</a>() <span class="keyword">const</span> = 0;
+<a name="l00176"></a>00176         <span class="comment"></span>
+<a name="l00177"></a>00177 <span class="comment">        /**</span>
+<a name="l00178"></a>00178 <span class="comment">         * Set a hard limit on the number of application instances that a single application</span>
+<a name="l00179"></a>00179 <span class="comment">         * may spawn in this ApplicationPool. The exact behavior depends on the used algorithm, </span>
+<a name="l00180"></a>00180 <span class="comment">         * and is not specified by these API docs.</span>
+<a name="l00181"></a>00181 <span class="comment">         *</span>
+<a name="l00182"></a>00182 <span class="comment">         * It is allowed to set a limit lower than the current number of spawned applications.</span>
+<a name="l00183"></a>00183 <span class="comment">         */</span>
+<a name="l00184"></a>00184         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ApplicationPool.html#b0437434c79b5444ac0faf768f1410e8" title="Set a hard limit on the number of application instances that a single application...">setMaxPerApp</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max) = 0;
+<a name="l00185"></a>00185         <span class="comment"></span>
+<a name="l00186"></a>00186 <span class="comment">        /**</span>
+<a name="l00187"></a>00187 <span class="comment">         * Get the process ID of the spawn server that is used.</span>
+<a name="l00188"></a>00188 <span class="comment">         *</span>
+<a name="l00189"></a>00189 <span class="comment">         * This method exposes an implementation detail. It is used by unit tests to verify</span>
+<a name="l00190"></a>00190 <span class="comment">         * that the implementation is correct, and thus should not be used directly.</span>
+<a name="l00191"></a>00191 <span class="comment">         */</span>
+<a name="l00192"></a>00192         <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1ApplicationPool.html#d9149c3b434ef8e18fd15a77af1a6c2c" title="Get the process ID of the spawn server that is used.">getSpawnServerPid</a>() <span class="keyword">const</span> = 0;
+<a name="l00193"></a>00193 };
+<a name="l00194"></a>00194 
+<a name="l00195"></a>00195 <span class="keyword">typedef</span> shared_ptr&lt;ApplicationPool&gt; ApplicationPoolPtr;
 <a name="l00196"></a>00196 
-<a name="l00197"></a>00197 <span class="keyword">typedef</span> shared_ptr&lt;ApplicationPool&gt; ApplicationPoolPtr;
+<a name="l00197"></a>00197 }; <span class="comment">// namespace Passenger</span>
 <a name="l00198"></a>00198 
-<a name="l00199"></a>00199 }; <span class="comment">// namespace Passenger</span>
-<a name="l00200"></a>00200 
-<a name="l00201"></a>00201 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_APPLICATION_POOL_H_ */</span>
+<a name="l00199"></a>00199 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_APPLICATION_POOL_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:24 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:32 2009 for Passenger by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
 </body>

data/doc/cxxapi/Application_8h-source.html

@@ -10,7 +10,6 @@
     <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>
@@ -39,409 +38,510 @@
 <a name="l00022"></a>00022 <span class="preprocessor"></span>
 <a name="l00023"></a>00023 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
 <a name="l00024"></a>00024 <span class="preprocessor">#include &lt;boost/function.hpp&gt;</span>
-<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;string&gt;</span>
-<a name="l00026"></a>00026 
-<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
-<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
-<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;sys/un.h&gt;</span>
-<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
-<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;errno.h&gt;</span>
-<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;ctime&gt;</span>
-<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;cstring&gt;</span>
-<a name="l00034"></a>00034 
-<a name="l00035"></a>00035 <span class="preprocessor">#include "MessageChannel.h"</span>
-<a name="l00036"></a>00036 <span class="preprocessor">#include "Exceptions.h"</span>
-<a name="l00037"></a>00037 <span class="preprocessor">#include "Logging.h"</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
+<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;oxt/backtrace.hpp&gt;</span>
+<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;vector&gt;</span>
+<a name="l00029"></a>00029 
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;sys/un.h&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;netdb.h&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;errno.h&gt;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;ctime&gt;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;cstring&gt;</span>
 <a name="l00038"></a>00038 
-<a name="l00039"></a><a class="code" href="namespacePassenger.html">00039</a> <span class="keyword">namespace </span>Passenger {
-<a name="l00040"></a>00040 
-<a name="l00041"></a>00041 <span class="keyword">using namespace </span>std;
-<a name="l00042"></a>00042 <span class="keyword">using namespace </span>boost;
-<a name="l00043"></a>00043 <span class="comment"></span>
-<a name="l00044"></a>00044 <span class="comment">/**</span>
-<a name="l00045"></a>00045 <span class="comment"> * Represents a single Ruby on Rails or Rack application instance.</span>
-<a name="l00046"></a>00046 <span class="comment"> *</span>
-<a name="l00047"></a>00047 <span class="comment"> * @ingroup Support</span>
-<a name="l00048"></a>00048 <span class="comment"> */</span>
-<a name="l00049"></a><a class="code" href="classPassenger_1_1Application.html">00049</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails or Rack application instance.">Application</a> {
-<a name="l00050"></a>00050 <span class="keyword">public</span>:
-<a name="l00051"></a><a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9">00051</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails or...">Session</a>;<span class="comment"></span>
-<a name="l00052"></a>00052 <span class="comment">        /** Convenient alias for Session smart pointer. */</span>
-<a name="l00053"></a>00053         <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a>;
-<a name="l00054"></a>00054         <span class="comment"></span>
-<a name="l00055"></a>00055 <span class="comment">        /**</span>
-<a name="l00056"></a>00056 <span class="comment">         * Represents the life time of a single request/response pair of a</span>
-<a name="l00057"></a>00057 <span class="comment">         * Ruby on Rails or Rack application.</span>
-<a name="l00058"></a>00058 <span class="comment">         *</span>
-<a name="l00059"></a>00059 <span class="comment">         * Session is used to forward a single HTTP request to a Ruby on Rails/Rack</span>
-<a name="l00060"></a>00060 <span class="comment">         * application. A Session has two communication channels: one for reading data</span>
-<a name="l00061"></a>00061 <span class="comment">         * from the application, and one for writing data to the application.</span>
-<a name="l00062"></a>00062 <span class="comment">         *</span>
-<a name="l00063"></a>00063 <span class="comment">         * In general, a session object is to be used in the following manner:</span>
-<a name="l00064"></a>00064 <span class="comment">         *</span>
-<a name="l00065"></a>00065 <span class="comment">         *  -# Convert the HTTP request headers into a string, as expected by sendHeaders().</span>
-<a name="l00066"></a>00066 <span class="comment">         *     Then send that string by calling sendHeaders().</span>
-<a name="l00067"></a>00067 <span class="comment">         *  -# In case of a POST of PUT request, send the HTTP request body by calling</span>
-<a name="l00068"></a>00068 <span class="comment">         *     sendBodyBlock(), possibly multiple times.</span>
-<a name="l00069"></a>00069 <span class="comment">         *  -# Shutdown the writer channel since you're now done sending data.</span>
-<a name="l00070"></a>00070 <span class="comment">         *  -# The HTTP response can now be read through the reader channel (getStream()).</span>
-<a name="l00071"></a>00071 <span class="comment">         *  -# When the HTTP response has been read, the session must be closed.</span>
-<a name="l00072"></a>00072 <span class="comment">         *     This is done by destroying the Session object.</span>
-<a name="l00073"></a>00073 <span class="comment">         *</span>
-<a name="l00074"></a>00074 <span class="comment">         * A usage example is shown in Application::connect(). </span>
-<a name="l00075"></a>00075 <span class="comment">         */</span>
-<a name="l00076"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html">00076</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails or...">Session</a> {
-<a name="l00077"></a>00077         <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00078"></a>00078 <span class="comment">                /**</span>
-<a name="l00079"></a>00079 <span class="comment">                 * Implementing classes might throw arbitrary exceptions.</span>
-<a name="l00080"></a>00080 <span class="comment">                 */</span>
-<a name="l00081"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c">00081</a>                 <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c" title="Implementing classes might throw arbitrary exceptions.">~Session</a>() {}
-<a name="l00082"></a>00082                 <span class="comment"></span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include "MessageChannel.h"</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include "Exceptions.h"</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include "Logging.h"</span>
+<a name="l00042"></a>00042 <span class="preprocessor">#include "Utils.h"</span>
+<a name="l00043"></a>00043 
+<a name="l00044"></a>00044 <span class="keyword">namespace </span>Passenger {
+<a name="l00045"></a>00045 
+<a name="l00046"></a>00046 <span class="keyword">using namespace </span>std;
+<a name="l00047"></a>00047 <span class="keyword">using namespace </span>boost;
+<a name="l00048"></a>00048 <span class="comment"></span>
+<a name="l00049"></a>00049 <span class="comment">/**</span>
+<a name="l00050"></a>00050 <span class="comment"> * Represents a single Ruby on Rails or Rack application instance.</span>
+<a name="l00051"></a>00051 <span class="comment"> *</span>
+<a name="l00052"></a>00052 <span class="comment"> * @ingroup Support</span>
+<a name="l00053"></a>00053 <span class="comment"> */</span>
+<a name="l00054"></a><a class="code" href="classPassenger_1_1Application.html">00054</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails or Rack application instance.">Application</a> {
+<a name="l00055"></a>00055 <span class="keyword">public</span>:
+<a name="l00056"></a><a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9">00056</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails or...">Session</a>;<span class="comment"></span>
+<a name="l00057"></a>00057 <span class="comment">        /** Convenient alias for Session smart pointer. */</span>
+<a name="l00058"></a>00058         <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a>;
+<a name="l00059"></a>00059         <span class="comment"></span>
+<a name="l00060"></a>00060 <span class="comment">        /**</span>
+<a name="l00061"></a>00061 <span class="comment">         * Represents the life time of a single request/response pair of a</span>
+<a name="l00062"></a>00062 <span class="comment">         * Ruby on Rails or Rack application.</span>
+<a name="l00063"></a>00063 <span class="comment">         *</span>
+<a name="l00064"></a>00064 <span class="comment">         * Session is used to forward a single HTTP request to a Ruby on Rails/Rack</span>
+<a name="l00065"></a>00065 <span class="comment">         * application. A Session has two communication channels: one for reading data</span>
+<a name="l00066"></a>00066 <span class="comment">         * from the application, and one for writing data to the application.</span>
+<a name="l00067"></a>00067 <span class="comment">         *</span>
+<a name="l00068"></a>00068 <span class="comment">         * In general, a session object is to be used in the following manner:</span>
+<a name="l00069"></a>00069 <span class="comment">         *</span>
+<a name="l00070"></a>00070 <span class="comment">         *  -# Convert the HTTP request headers into a string, as expected by sendHeaders().</span>
+<a name="l00071"></a>00071 <span class="comment">         *     Then send that string by calling sendHeaders().</span>
+<a name="l00072"></a>00072 <span class="comment">         *  -# In case of a POST of PUT request, send the HTTP request body by calling</span>
+<a name="l00073"></a>00073 <span class="comment">         *     sendBodyBlock(), possibly multiple times.</span>
+<a name="l00074"></a>00074 <span class="comment">         *  -# Shutdown the writer channel since you're now done sending data.</span>
+<a name="l00075"></a>00075 <span class="comment">         *  -# The HTTP response can now be read through the reader channel (getStream()).</span>
+<a name="l00076"></a>00076 <span class="comment">         *  -# When the HTTP response has been read, the session must be closed.</span>
+<a name="l00077"></a>00077 <span class="comment">         *     This is done by destroying the Session object.</span>
+<a name="l00078"></a>00078 <span class="comment">         *</span>
+<a name="l00079"></a>00079 <span class="comment">         * A usage example is shown in Application::connect(). </span>
+<a name="l00080"></a>00080 <span class="comment">         */</span>
+<a name="l00081"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html">00081</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails or...">Session</a> {
+<a name="l00082"></a>00082         <span class="keyword">public</span>:<span class="comment"></span>
 <a name="l00083"></a>00083 <span class="comment">                /**</span>
-<a name="l00084"></a>00084 <span class="comment">                 * Send HTTP request headers to the application. The HTTP headers must be</span>
-<a name="l00085"></a>00085 <span class="comment">                 * converted into CGI headers, and then encoded into a string that matches this grammar:</span>
-<a name="l00086"></a>00086 <span class="comment">                 *</span>
-<a name="l00087"></a>00087 <span class="comment">                   @verbatim</span>
-<a name="l00088"></a>00088 <span class="comment">                   headers ::= header*</span>
-<a name="l00089"></a>00089 <span class="comment">                   header ::= name NUL value NUL</span>
-<a name="l00090"></a>00090 <span class="comment">                   name ::= notnull+</span>
-<a name="l00091"></a>00091 <span class="comment">                   value ::= notnull+</span>
-<a name="l00092"></a>00092 <span class="comment">                   notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span>
-<a name="l00093"></a>00093 <span class="comment">                   NUL = "\x00"</span>
-<a name="l00094"></a>00094 <span class="comment">                   @endverbatim</span>
-<a name="l00095"></a>00095 <span class="comment">                 *</span>
-<a name="l00096"></a>00096 <span class="comment">                 * This method should be the first one to be called during the lifetime of a Session</span>
-<a name="l00097"></a>00097 <span class="comment">                 * object. Otherwise strange things may happen.</span>
-<a name="l00098"></a>00098 <span class="comment">                 *</span>
-<a name="l00099"></a>00099 <span class="comment">                 * @param headers The HTTP request headers, converted into CGI headers and encoded as</span>
-<a name="l00100"></a>00100 <span class="comment">                 *                a string, according to the description.</span>
-<a name="l00101"></a>00101 <span class="comment">                 * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span>
-<a name="l00102"></a>00102 <span class="comment">                 * @pre headers != NULL</span>
-<a name="l00103"></a>00103 <span class="comment">                 * @throws IOException The writer channel has already been closed.</span>
-<a name="l00104"></a>00104 <span class="comment">                 * @throws SystemException Something went wrong during writing.</span>
-<a name="l00105"></a>00105 <span class="comment">                 * @throws boost::thread_interrupted</span>
-<a name="l00106"></a>00106 <span class="comment">                 */</span>
-<a name="l00107"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360">00107</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *headers, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
-<a name="l00108"></a>00108                         <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>();
-<a name="l00109"></a>00109                         <span class="keywordflow">if</span> (stream == -1) {
-<a name="l00110"></a>00110                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write headers to the request handler "</span>
-<a name="l00111"></a>00111                                         <span class="stringliteral">"because the writer stream has already been closed."</span>);
-<a name="l00112"></a>00112                         }
-<a name="l00113"></a>00113                         <span class="keywordflow">try</span> {
-<a name="l00114"></a>00114                                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeScalar(headers, size);
-<a name="l00115"></a>00115                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) {
-<a name="l00116"></a>00116                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"An error occured while writing headers "</span>
-<a name="l00117"></a>00117                                         <span class="stringliteral">"to the request handler"</span>, e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>());
+<a name="l00084"></a>00084 <span class="comment">                 * Implementing classes might throw arbitrary exceptions.</span>
+<a name="l00085"></a>00085 <span class="comment">                 */</span>
+<a name="l00086"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c">00086</a>                 <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c" title="Implementing classes might throw arbitrary exceptions.">~Session</a>() {}
+<a name="l00087"></a>00087                 <span class="comment"></span>
+<a name="l00088"></a>00088 <span class="comment">                /**</span>
+<a name="l00089"></a>00089 <span class="comment">                 * Send HTTP request headers to the application. The HTTP headers must be</span>
+<a name="l00090"></a>00090 <span class="comment">                 * converted into CGI headers, and then encoded into a string that matches this grammar:</span>
+<a name="l00091"></a>00091 <span class="comment">                 *</span>
+<a name="l00092"></a>00092 <span class="comment">                   @verbatim</span>
+<a name="l00093"></a>00093 <span class="comment">                   headers ::= header*</span>
+<a name="l00094"></a>00094 <span class="comment">                   header ::= name NUL value NUL</span>
+<a name="l00095"></a>00095 <span class="comment">                   name ::= notnull+</span>
+<a name="l00096"></a>00096 <span class="comment">                   value ::= notnull+</span>
+<a name="l00097"></a>00097 <span class="comment">                   notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span>
+<a name="l00098"></a>00098 <span class="comment">                   NUL = "\x00"</span>
+<a name="l00099"></a>00099 <span class="comment">                   @endverbatim</span>
+<a name="l00100"></a>00100 <span class="comment">                 *</span>
+<a name="l00101"></a>00101 <span class="comment">                 * This method should be the first one to be called during the lifetime of a Session</span>
+<a name="l00102"></a>00102 <span class="comment">                 * object. Otherwise strange things may happen.</span>
+<a name="l00103"></a>00103 <span class="comment">                 *</span>
+<a name="l00104"></a>00104 <span class="comment">                 * @param headers The HTTP request headers, converted into CGI headers and encoded as</span>
+<a name="l00105"></a>00105 <span class="comment">                 *                a string, according to the description.</span>
+<a name="l00106"></a>00106 <span class="comment">                 * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span>
+<a name="l00107"></a>00107 <span class="comment">                 * @pre headers != NULL</span>
+<a name="l00108"></a>00108 <span class="comment">                 * @throws IOException The writer channel has already been closed.</span>
+<a name="l00109"></a>00109 <span class="comment">                 * @throws SystemException Something went wrong during writing.</span>
+<a name="l00110"></a>00110 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00111"></a>00111 <span class="comment">                 */</span>
+<a name="l00112"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360">00112</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *headers, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00113"></a>00113                         TRACE_POINT();
+<a name="l00114"></a>00114                         <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>();
+<a name="l00115"></a>00115                         <span class="keywordflow">if</span> (stream == -1) {
+<a name="l00116"></a>00116                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write headers to the request handler "</span>
+<a name="l00117"></a>00117                                         <span class="stringliteral">"because the writer stream has already been closed."</span>);
 <a name="l00118"></a>00118                         }
-<a name="l00119"></a>00119                 }
-<a name="l00120"></a>00120                 <span class="comment"></span>
-<a name="l00121"></a>00121 <span class="comment">                /**</span>
-<a name="l00122"></a>00122 <span class="comment">                 * Convenience shortcut for sendHeaders(const char *, unsigned int)</span>
-<a name="l00123"></a>00123 <span class="comment">                 * @param headers</span>
-<a name="l00124"></a>00124 <span class="comment">                 * @throws IOException The writer channel has already been closed.</span>
-<a name="l00125"></a>00125 <span class="comment">                 * @throws SystemException Something went wrong during writing.</span>
-<a name="l00126"></a>00126 <span class="comment">                 * @throws boost::thread_interrupted</span>
-<a name="l00127"></a>00127 <span class="comment">                 */</span>
-<a name="l00128"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fee03667f626d68c565495bcb19771a">00128</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;headers) {
-<a name="l00129"></a>00129                         <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(headers.c_str(), headers.size());
-<a name="l00130"></a>00130                 }
-<a name="l00131"></a>00131                 <span class="comment"></span>
-<a name="l00132"></a>00132 <span class="comment">                /**</span>
-<a name="l00133"></a>00133 <span class="comment">                 * Send a chunk of HTTP request body data to the application.</span>
-<a name="l00134"></a>00134 <span class="comment">                 * You can call this method as many times as is required to transfer</span>
-<a name="l00135"></a>00135 <span class="comment">                 * the entire HTTP request body.</span>
-<a name="l00136"></a>00136 <span class="comment">                 *</span>
-<a name="l00137"></a>00137 <span class="comment">                 * This method should only be called after a sendHeaders(). Otherwise</span>
-<a name="l00138"></a>00138 <span class="comment">                 * strange things may happen.</span>
-<a name="l00139"></a>00139 <span class="comment">                 *</span>
-<a name="l00140"></a>00140 <span class="comment">                 * @param block A block of HTTP request body data to send.</span>
-<a name="l00141"></a>00141 <span class="comment">                 * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span>
-<a name="l00142"></a>00142 <span class="comment">                 * @throws IOException The writer channel has already been closed.</span>
-<a name="l00143"></a>00143 <span class="comment">                 * @throws SystemException Something went wrong during writing.</span>
-<a name="l00144"></a>00144 <span class="comment">                 * @throws boost::thread_interrupted</span>
-<a name="l00145"></a>00145 <span class="comment">                 */</span>
-<a name="l00146"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669">00146</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669" title="Send a chunk of HTTP request body data to the application.">sendBodyBlock</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *block, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
-<a name="l00147"></a>00147                         <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>();
-<a name="l00148"></a>00148                         <span class="keywordflow">if</span> (stream == -1) {
-<a name="l00149"></a>00149                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write request body block to the "</span>
-<a name="l00150"></a>00150                                         <span class="stringliteral">"request handler because the writer stream has "</span>
-<a name="l00151"></a>00151                                         <span class="stringliteral">"already been closed."</span>);
-<a name="l00152"></a>00152                         }
-<a name="l00153"></a>00153                         <span class="keywordflow">try</span> {
-<a name="l00154"></a>00154                                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeRaw(block, size);
-<a name="l00155"></a>00155                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) {
-<a name="l00156"></a>00156                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"An error occured while sending the "</span>
-<a name="l00157"></a>00157                                         <span class="stringliteral">"request body to the request handler"</span>, e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>());
-<a name="l00158"></a>00158                         }
-<a name="l00159"></a>00159                 }
-<a name="l00160"></a>00160                 <span class="comment"></span>
-<a name="l00161"></a>00161 <span class="comment">                /**</span>
-<a name="l00162"></a>00162 <span class="comment">                 * Get the I/O stream's file descriptor. This steam is full-duplex,</span>
-<a name="l00163"></a>00163 <span class="comment">                 * and will be automatically closed upon Session's destruction,</span>
-<a name="l00164"></a>00164 <span class="comment">                 * unless discardStream() is called.</span>
-<a name="l00165"></a>00165 <span class="comment">                 *</span>
-<a name="l00166"></a>00166 <span class="comment">                 * @pre The stream has not been fully closed.</span>
-<a name="l00167"></a>00167 <span class="comment">                 */</span>
-<a name="l00168"></a>00168                 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0;
+<a name="l00119"></a>00119                         <span class="keywordflow">try</span> {
+<a name="l00120"></a>00120                                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeScalar(headers, size);
+<a name="l00121"></a>00121                         } <span class="keywordflow">catch</span> (<a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) {
+<a name="l00122"></a>00122                                 e.<a class="code" href="classPassenger_1_1SystemException.html#6fc359f27a084158b7111ef35bec114f">setBriefMessage</a>(<span class="stringliteral">"An error occured while writing headers "</span>
+<a name="l00123"></a>00123                                         <span class="stringliteral">"to the request handler"</span>);
+<a name="l00124"></a>00124                                 <span class="keywordflow">throw</span>;
+<a name="l00125"></a>00125                         }
+<a name="l00126"></a>00126                 }
+<a name="l00127"></a>00127                 <span class="comment"></span>
+<a name="l00128"></a>00128 <span class="comment">                /**</span>
+<a name="l00129"></a>00129 <span class="comment">                 * Convenience shortcut for sendHeaders(const char *, unsigned int)</span>
+<a name="l00130"></a>00130 <span class="comment">                 * @param headers</span>
+<a name="l00131"></a>00131 <span class="comment">                 * @throws IOException The writer channel has already been closed.</span>
+<a name="l00132"></a>00132 <span class="comment">                 * @throws SystemException Something went wrong during writing.</span>
+<a name="l00133"></a>00133 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00134"></a>00134 <span class="comment">                 */</span>
+<a name="l00135"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fee03667f626d68c565495bcb19771a">00135</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;headers) {
+<a name="l00136"></a>00136                         <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(headers.c_str(), headers.size());
+<a name="l00137"></a>00137                 }
+<a name="l00138"></a>00138                 <span class="comment"></span>
+<a name="l00139"></a>00139 <span class="comment">                /**</span>
+<a name="l00140"></a>00140 <span class="comment">                 * Send a chunk of HTTP request body data to the application.</span>
+<a name="l00141"></a>00141 <span class="comment">                 * You can call this method as many times as is required to transfer</span>
+<a name="l00142"></a>00142 <span class="comment">                 * the entire HTTP request body.</span>
+<a name="l00143"></a>00143 <span class="comment">                 *</span>
+<a name="l00144"></a>00144 <span class="comment">                 * This method should only be called after a sendHeaders(). Otherwise</span>
+<a name="l00145"></a>00145 <span class="comment">                 * strange things may happen.</span>
+<a name="l00146"></a>00146 <span class="comment">                 *</span>
+<a name="l00147"></a>00147 <span class="comment">                 * @param block A block of HTTP request body data to send.</span>
+<a name="l00148"></a>00148 <span class="comment">                 * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span>
+<a name="l00149"></a>00149 <span class="comment">                 * @throws IOException The writer channel has already been closed.</span>
+<a name="l00150"></a>00150 <span class="comment">                 * @throws SystemException Something went wrong during writing.</span>
+<a name="l00151"></a>00151 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00152"></a>00152 <span class="comment">                 */</span>
+<a name="l00153"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669">00153</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669" title="Send a chunk of HTTP request body data to the application.">sendBodyBlock</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *block, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00154"></a>00154                         TRACE_POINT();
+<a name="l00155"></a>00155                         <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>();
+<a name="l00156"></a>00156                         <span class="keywordflow">if</span> (stream == -1) {
+<a name="l00157"></a>00157                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write request body block to the "</span>
+<a name="l00158"></a>00158                                         <span class="stringliteral">"request handler because the writer stream has "</span>
+<a name="l00159"></a>00159                                         <span class="stringliteral">"already been closed."</span>);
+<a name="l00160"></a>00160                         }
+<a name="l00161"></a>00161                         <span class="keywordflow">try</span> {
+<a name="l00162"></a>00162                                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeRaw(block, size);
+<a name="l00163"></a>00163                         } <span class="keywordflow">catch</span> (<a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) {
+<a name="l00164"></a>00164                                 e.<a class="code" href="classPassenger_1_1SystemException.html#6fc359f27a084158b7111ef35bec114f">setBriefMessage</a>(<span class="stringliteral">"An error occured while sending the "</span>
+<a name="l00165"></a>00165                                         <span class="stringliteral">"request body to the request handler"</span>);
+<a name="l00166"></a>00166                                 <span class="keywordflow">throw</span>;
+<a name="l00167"></a>00167                         }
+<a name="l00168"></a>00168                 }
 <a name="l00169"></a>00169                 <span class="comment"></span>
 <a name="l00170"></a>00170 <span class="comment">                /**</span>
-<a name="l00171"></a>00171 <span class="comment">                 * Indicate that we don't want to read data anymore from the I/O stream.</span>
-<a name="l00172"></a>00172 <span class="comment">                 * Calling this method after closeStream() is called will have no effect.</span>
-<a name="l00173"></a>00173 <span class="comment">                 *</span>
-<a name="l00174"></a>00174 <span class="comment">                 * @throws SystemException Something went wrong.</span>
-<a name="l00175"></a>00175 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00171"></a>00171 <span class="comment">                 * Get the I/O stream's file descriptor. This steam is full-duplex,</span>
+<a name="l00172"></a>00172 <span class="comment">                 * and will be automatically closed upon Session's destruction,</span>
+<a name="l00173"></a>00173 <span class="comment">                 * unless discardStream() is called.</span>
+<a name="l00174"></a>00174 <span class="comment">                 *</span>
+<a name="l00175"></a>00175 <span class="comment">                 * @pre The stream has not been fully closed.</span>
 <a name="l00176"></a>00176 <span class="comment">                 */</span>
-<a name="l00177"></a>00177                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#45ad442dc1f4e7b73782bb3395d9e97d" title="Indicate that we don&amp;#39;t want to read data anymore from the I/O stream.">shutdownReader</a>() = 0;
+<a name="l00177"></a>00177                 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0;
 <a name="l00178"></a>00178                 <span class="comment"></span>
 <a name="l00179"></a>00179 <span class="comment">                /**</span>
-<a name="l00180"></a>00180 <span class="comment">                 * Indicate that we don't want to write data anymore to the I/O stream.</span>
-<a name="l00181"></a>00181 <span class="comment">                 * Calling this method after closeStream() is called will have no effect.</span>
-<a name="l00182"></a>00182 <span class="comment">                 *</span>
-<a name="l00183"></a>00183 <span class="comment">                 * @throws SystemException Something went wrong.</span>
-<a name="l00184"></a>00184 <span class="comment">                 * @throws boost::thread_interrupted</span>
-<a name="l00185"></a>00185 <span class="comment">                 */</span>
-<a name="l00186"></a>00186                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#dff449398adb872c93a9572ae4b701fb" title="Indicate that we don&amp;#39;t want to write data anymore to the I/O stream.">shutdownWriter</a>() = 0;
-<a name="l00187"></a>00187                 <span class="comment"></span>
-<a name="l00188"></a>00188 <span class="comment">                /**</span>
-<a name="l00189"></a>00189 <span class="comment">                 * Close the I/O stream.</span>
-<a name="l00190"></a>00190 <span class="comment">                 *</span>
-<a name="l00191"></a>00191 <span class="comment">                 * @throws SystemException Something went wrong.</span>
-<a name="l00192"></a>00192 <span class="comment">                 * @throws boost::thread_interrupted</span>
-<a name="l00193"></a>00193 <span class="comment">                 */</span>
-<a name="l00194"></a>00194                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#ddfeda914b17749a70016f5eb384f8a9" title="Close the I/O stream.">closeStream</a>() = 0;
-<a name="l00195"></a>00195                 <span class="comment"></span>
-<a name="l00196"></a>00196 <span class="comment">                /**</span>
-<a name="l00197"></a>00197 <span class="comment">                 * Discard the I/O stream's file descriptor, so that Session won't automatically</span>
-<a name="l00198"></a>00198 <span class="comment">                 * closed it upon Session's destruction.</span>
-<a name="l00199"></a>00199 <span class="comment">                 */</span>
-<a name="l00200"></a>00200                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#7f9ad70e75d21130d914d2134061c757" title="Discard the I/O stream&amp;#39;s file descriptor, so that Session won&amp;#39;t automatically...">discardStream</a>() = 0;
-<a name="l00201"></a>00201                 <span class="comment"></span>
-<a name="l00202"></a>00202 <span class="comment">                /**</span>
-<a name="l00203"></a>00203 <span class="comment">                 * Get the process ID of the application instance that belongs to this session.</span>
-<a name="l00204"></a>00204 <span class="comment">                 */</span>
-<a name="l00205"></a>00205                 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application_1_1Session.html#2215bec32917c48d1a9f6386b88d018b" title="Get the process ID of the application instance that belongs to this session.">getPid</a>() <span class="keyword">const</span> = 0;
-<a name="l00206"></a>00206         };
-<a name="l00207"></a>00207 
-<a name="l00208"></a>00208 <span class="keyword">private</span>:<span class="comment"></span>
-<a name="l00209"></a>00209 <span class="comment">        /**</span>
-<a name="l00210"></a>00210 <span class="comment">         * A "standard" implementation of Session.</span>
-<a name="l00211"></a>00211 <span class="comment">         */</span>
-<a name="l00212"></a>00212         <span class="keyword">class </span>StandardSession: <span class="keyword">public</span> Session {
-<a name="l00213"></a>00213         <span class="keyword">protected</span>:
-<a name="l00214"></a>00214                 function&lt;void()&gt; closeCallback;
-<a name="l00215"></a>00215                 <span class="keywordtype">int</span> fd;
-<a name="l00216"></a>00216                 pid_t pid;
-<a name="l00217"></a>00217                 
-<a name="l00218"></a>00218         <span class="keyword">public</span>:
-<a name="l00219"></a>00219                 StandardSession(pid_t pid,
-<a name="l00220"></a>00220                                 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback,
-<a name="l00221"></a>00221                                 <span class="keywordtype">int</span> fd) {
-<a name="l00222"></a>00222                         this-&gt;pid = pid;
-<a name="l00223"></a>00223                         this-&gt;closeCallback = closeCallback;
-<a name="l00224"></a>00224                         this-&gt;fd = fd;
-<a name="l00225"></a>00225                 }
-<a name="l00226"></a>00226         
-<a name="l00227"></a>00227                 <span class="keyword">virtual</span> ~StandardSession() {
-<a name="l00228"></a>00228                         closeStream();
-<a name="l00229"></a>00229                         closeCallback();
-<a name="l00230"></a>00230                 }
-<a name="l00231"></a>00231                 
-<a name="l00232"></a>00232                 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getStream()<span class="keyword"> const </span>{
-<a name="l00233"></a>00233                         <span class="keywordflow">return</span> fd;
-<a name="l00234"></a>00234                 }
-<a name="l00235"></a>00235                 
-<a name="l00236"></a>00236                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdownReader() {
-<a name="l00237"></a>00237                         <span class="keywordflow">if</span> (fd != -1) {
-<a name="l00238"></a>00238                                 <span class="keywordtype">int</span> ret = InterruptableCalls::shutdown(fd, SHUT_RD);
-<a name="l00239"></a>00239                                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00240"></a>00240                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot shutdown the writer stream"</span>,
-<a name="l00241"></a>00241                                                 errno);
-<a name="l00242"></a>00242                                 }
-<a name="l00243"></a>00243                         }
-<a name="l00244"></a>00244                 }
-<a name="l00245"></a>00245                 
-<a name="l00246"></a>00246                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdownWriter() {
-<a name="l00247"></a>00247                         <span class="keywordflow">if</span> (fd != -1) {
-<a name="l00248"></a>00248                                 <span class="keywordtype">int</span> ret = InterruptableCalls::shutdown(fd, SHUT_WR);
-<a name="l00249"></a>00249                                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00250"></a>00250                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot shutdown the writer stream"</span>,
-<a name="l00251"></a>00251                                                 errno);
-<a name="l00252"></a>00252                                 }
-<a name="l00253"></a>00253                         }
-<a name="l00254"></a>00254                 }
-<a name="l00255"></a>00255                 
-<a name="l00256"></a>00256                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> closeStream() {
-<a name="l00257"></a>00257                         <span class="keywordflow">if</span> (fd != -1) {
-<a name="l00258"></a>00258                                 <span class="keywordtype">int</span> ret = InterruptableCalls::close(fd);
-<a name="l00259"></a>00259                                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00260"></a>00260                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot close the session stream"</span>,
-<a name="l00261"></a>00261                                                 errno);
-<a name="l00262"></a>00262                                 }
-<a name="l00263"></a>00263                                 fd = -1;
-<a name="l00264"></a>00264                         }
-<a name="l00265"></a>00265                 }
-<a name="l00266"></a>00266                 
-<a name="l00267"></a>00267                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> discardStream() {
-<a name="l00268"></a>00268                         fd = -1;
-<a name="l00269"></a>00269                 }
-<a name="l00270"></a>00270                 
-<a name="l00271"></a>00271                 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{
-<a name="l00272"></a>00272                         <span class="keywordflow">return</span> pid;
-<a name="l00273"></a>00273                 }
-<a name="l00274"></a>00274         };
-<a name="l00275"></a>00275 
-<a name="l00276"></a>00276         <span class="keywordtype">string</span> appRoot;
-<a name="l00277"></a>00277         pid_t pid;
-<a name="l00278"></a>00278         <span class="keywordtype">string</span> listenSocketName;
-<a name="l00279"></a>00279         <span class="keywordtype">bool</span> usingAbstractNamespace;
-<a name="l00280"></a>00280         <span class="keywordtype">int</span> ownerPipe;
-<a name="l00281"></a>00281 
-<a name="l00282"></a>00282 <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00283"></a>00283 <span class="comment">        /**</span>
-<a name="l00284"></a>00284 <span class="comment">         * Construct a new Application object.</span>
-<a name="l00285"></a>00285 <span class="comment">         *</span>
-<a name="l00286"></a>00286 <span class="comment">         * @param theAppRoot The application root of an application. In case of a Rails application,</span>
-<a name="l00287"></a>00287 <span class="comment">         *             this is the folder that contains 'app/', 'public/', 'config/', etc.</span>
-<a name="l00288"></a>00288 <span class="comment">         *             This must be a valid directory, but the path does not have to be absolute.</span>
-<a name="l00289"></a>00289 <span class="comment">         * @param pid The process ID of this application instance.</span>
-<a name="l00290"></a>00290 <span class="comment">         * @param listenSocketName The name of the listener socket of this application instance.</span>
-<a name="l00291"></a>00291 <span class="comment">         * @param usingAbstractNamespace Whether &lt;tt&gt;listenSocketName&lt;/tt&gt; refers to a Unix</span>
-<a name="l00292"></a>00292 <span class="comment">         *        socket on the abstract namespace. Note that listenSocketName must not</span>
-<a name="l00293"></a>00293 <span class="comment">         *        contain the leading null byte, even if it's an abstract namespace socket.</span>
-<a name="l00294"></a>00294 <span class="comment">         * @param ownerPipe The owner pipe of this application instance.</span>
-<a name="l00295"></a>00295 <span class="comment">         * @post getAppRoot() == theAppRoot &amp;&amp; getPid() == pid</span>
-<a name="l00296"></a>00296 <span class="comment">         */</span>
-<a name="l00297"></a><a class="code" href="classPassenger_1_1Application.html#163509167eef118470b72661ac8acd5d">00297</a>         <a class="code" href="classPassenger_1_1Application.html#163509167eef118470b72661ac8acd5d" title="Construct a new Application object.">Application</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;theAppRoot, pid_t pid, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;listenSocketName,
-<a name="l00298"></a>00298                     <span class="keywordtype">bool</span> usingAbstractNamespace, <span class="keywordtype">int</span> ownerPipe) {
-<a name="l00299"></a>00299                 appRoot = theAppRoot;
-<a name="l00300"></a>00300                 this-&gt;pid = pid;
-<a name="l00301"></a>00301                 this-&gt;listenSocketName = listenSocketName;
-<a name="l00302"></a>00302                 this-&gt;usingAbstractNamespace = usingAbstractNamespace;
-<a name="l00303"></a>00303                 this-&gt;ownerPipe = ownerPipe;
-<a name="l00304"></a>00304                 P_TRACE(3, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": created."</span>);
-<a name="l00305"></a>00305         }
-<a name="l00306"></a>00306         
-<a name="l00307"></a>00307         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails or Rack application instance.">Application</a>() {
-<a name="l00308"></a>00308                 <span class="keywordtype">int</span> ret;
+<a name="l00180"></a>00180 <span class="comment">                 * Set the timeout value for reading data from the I/O stream.</span>
+<a name="l00181"></a>00181 <span class="comment">                 * If no data can be read within the timeout period, then the</span>
+<a name="l00182"></a>00182 <span class="comment">                 * read call will fail with error EAGAIN or EWOULDBLOCK.</span>
+<a name="l00183"></a>00183 <span class="comment">                 *</span>
+<a name="l00184"></a>00184 <span class="comment">                 * @param msec The timeout, in milliseconds. If 0 is given,</span>
+<a name="l00185"></a>00185 <span class="comment">                 *             there will be no timeout.</span>
+<a name="l00186"></a>00186 <span class="comment">                 * @throws SystemException Cannot set the timeout.</span>
+<a name="l00187"></a>00187 <span class="comment">                 */</span>
+<a name="l00188"></a>00188                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#17b4b6e4c47ec8941a099e229d2944f2" title="Set the timeout value for reading data from the I/O stream.">setReaderTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) = 0;
+<a name="l00189"></a>00189                 <span class="comment"></span>
+<a name="l00190"></a>00190 <span class="comment">                /**</span>
+<a name="l00191"></a>00191 <span class="comment">                 * Set the timeout value for writing data from the I/O stream.</span>
+<a name="l00192"></a>00192 <span class="comment">                 * If no data can be written within the timeout period, then the</span>
+<a name="l00193"></a>00193 <span class="comment">                 * write call will fail with error EAGAIN or EWOULDBLOCK.</span>
+<a name="l00194"></a>00194 <span class="comment">                 *</span>
+<a name="l00195"></a>00195 <span class="comment">                 * @param msec The timeout, in milliseconds. If 0 is given,</span>
+<a name="l00196"></a>00196 <span class="comment">                 *             there will be no timeout.</span>
+<a name="l00197"></a>00197 <span class="comment">                 * @throws SystemException Cannot set the timeout.</span>
+<a name="l00198"></a>00198 <span class="comment">                 */</span>
+<a name="l00199"></a>00199                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#4236abbdf69e10ded00c756de24433e9" title="Set the timeout value for writing data from the I/O stream.">setWriterTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) = 0;
+<a name="l00200"></a>00200                 <span class="comment"></span>
+<a name="l00201"></a>00201 <span class="comment">                /**</span>
+<a name="l00202"></a>00202 <span class="comment">                 * Indicate that we don't want to read data anymore from the I/O stream.</span>
+<a name="l00203"></a>00203 <span class="comment">                 * Calling this method after closeStream() is called will have no effect.</span>
+<a name="l00204"></a>00204 <span class="comment">                 *</span>
+<a name="l00205"></a>00205 <span class="comment">                 * @throws SystemException Something went wrong.</span>
+<a name="l00206"></a>00206 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00207"></a>00207 <span class="comment">                 */</span>
+<a name="l00208"></a>00208                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#45ad442dc1f4e7b73782bb3395d9e97d" title="Indicate that we don&amp;#39;t want to read data anymore from the I/O stream.">shutdownReader</a>() = 0;
+<a name="l00209"></a>00209                 <span class="comment"></span>
+<a name="l00210"></a>00210 <span class="comment">                /**</span>
+<a name="l00211"></a>00211 <span class="comment">                 * Indicate that we don't want to write data anymore to the I/O stream.</span>
+<a name="l00212"></a>00212 <span class="comment">                 * Calling this method after closeStream() is called will have no effect.</span>
+<a name="l00213"></a>00213 <span class="comment">                 *</span>
+<a name="l00214"></a>00214 <span class="comment">                 * @throws SystemException Something went wrong.</span>
+<a name="l00215"></a>00215 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00216"></a>00216 <span class="comment">                 */</span>
+<a name="l00217"></a>00217                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#dff449398adb872c93a9572ae4b701fb" title="Indicate that we don&amp;#39;t want to write data anymore to the I/O stream.">shutdownWriter</a>() = 0;
+<a name="l00218"></a>00218                 <span class="comment"></span>
+<a name="l00219"></a>00219 <span class="comment">                /**</span>
+<a name="l00220"></a>00220 <span class="comment">                 * Close the I/O stream.</span>
+<a name="l00221"></a>00221 <span class="comment">                 *</span>
+<a name="l00222"></a>00222 <span class="comment">                 * @throws SystemException Something went wrong.</span>
+<a name="l00223"></a>00223 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00224"></a>00224 <span class="comment">                 */</span>
+<a name="l00225"></a>00225                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#ddfeda914b17749a70016f5eb384f8a9" title="Close the I/O stream.">closeStream</a>() = 0;
+<a name="l00226"></a>00226                 <span class="comment"></span>
+<a name="l00227"></a>00227 <span class="comment">                /**</span>
+<a name="l00228"></a>00228 <span class="comment">                 * Discard the I/O stream's file descriptor, so that Session won't automatically</span>
+<a name="l00229"></a>00229 <span class="comment">                 * closed it upon Session's destruction.</span>
+<a name="l00230"></a>00230 <span class="comment">                 */</span>
+<a name="l00231"></a>00231                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#7f9ad70e75d21130d914d2134061c757" title="Discard the I/O stream&amp;#39;s file descriptor, so that Session won&amp;#39;t automatically...">discardStream</a>() = 0;
+<a name="l00232"></a>00232                 <span class="comment"></span>
+<a name="l00233"></a>00233 <span class="comment">                /**</span>
+<a name="l00234"></a>00234 <span class="comment">                 * Get the process ID of the application instance that belongs to this session.</span>
+<a name="l00235"></a>00235 <span class="comment">                 */</span>
+<a name="l00236"></a>00236                 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application_1_1Session.html#2215bec32917c48d1a9f6386b88d018b" title="Get the process ID of the application instance that belongs to this session.">getPid</a>() <span class="keyword">const</span> = 0;
+<a name="l00237"></a>00237         };
+<a name="l00238"></a>00238 
+<a name="l00239"></a>00239 <span class="keyword">private</span>:<span class="comment"></span>
+<a name="l00240"></a>00240 <span class="comment">        /**</span>
+<a name="l00241"></a>00241 <span class="comment">         * A "standard" implementation of Session.</span>
+<a name="l00242"></a>00242 <span class="comment">         */</span>
+<a name="l00243"></a>00243         <span class="keyword">class </span>StandardSession: <span class="keyword">public</span> Session {
+<a name="l00244"></a>00244         <span class="keyword">protected</span>:
+<a name="l00245"></a>00245                 function&lt;void()&gt; closeCallback;
+<a name="l00246"></a>00246                 <span class="keywordtype">int</span> fd;
+<a name="l00247"></a>00247                 pid_t pid;
+<a name="l00248"></a>00248                 
+<a name="l00249"></a>00249         <span class="keyword">public</span>:
+<a name="l00250"></a>00250                 StandardSession(pid_t pid,
+<a name="l00251"></a>00251                                 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback,
+<a name="l00252"></a>00252                                 <span class="keywordtype">int</span> fd) {
+<a name="l00253"></a>00253                         this-&gt;pid = pid;
+<a name="l00254"></a>00254                         this-&gt;closeCallback = closeCallback;
+<a name="l00255"></a>00255                         this-&gt;fd = fd;
+<a name="l00256"></a>00256                 }
+<a name="l00257"></a>00257         
+<a name="l00258"></a>00258                 <span class="keyword">virtual</span> ~StandardSession() {
+<a name="l00259"></a>00259                         TRACE_POINT();
+<a name="l00260"></a>00260                         closeStream();
+<a name="l00261"></a>00261                         closeCallback();
+<a name="l00262"></a>00262                 }
+<a name="l00263"></a>00263                 
+<a name="l00264"></a>00264                 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getStream()<span class="keyword"> const </span>{
+<a name="l00265"></a>00265                         <span class="keywordflow">return</span> fd;
+<a name="l00266"></a>00266                 }
+<a name="l00267"></a>00267                 
+<a name="l00268"></a>00268                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setReaderTimeout(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
+<a name="l00269"></a>00269                         MessageChannel(fd).setReadTimeout(msec);
+<a name="l00270"></a>00270                 }
+<a name="l00271"></a>00271                 
+<a name="l00272"></a>00272                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setWriterTimeout(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
+<a name="l00273"></a>00273                         MessageChannel(fd).setWriteTimeout(msec);
+<a name="l00274"></a>00274                 }
+<a name="l00275"></a>00275                 
+<a name="l00276"></a>00276                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdownReader() {
+<a name="l00277"></a>00277                         TRACE_POINT();
+<a name="l00278"></a>00278                         <span class="keywordflow">if</span> (fd != -1) {
+<a name="l00279"></a>00279                                 <span class="keywordtype">int</span> ret = syscalls::shutdown(fd, SHUT_RD);
+<a name="l00280"></a>00280                                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00281"></a>00281                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot shutdown the writer stream"</span>,
+<a name="l00282"></a>00282                                                 errno);
+<a name="l00283"></a>00283                                 }
+<a name="l00284"></a>00284                         }
+<a name="l00285"></a>00285                 }
+<a name="l00286"></a>00286                 
+<a name="l00287"></a>00287                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdownWriter() {
+<a name="l00288"></a>00288                         TRACE_POINT();
+<a name="l00289"></a>00289                         <span class="keywordflow">if</span> (fd != -1) {
+<a name="l00290"></a>00290                                 <span class="keywordtype">int</span> ret = syscalls::shutdown(fd, SHUT_WR);
+<a name="l00291"></a>00291                                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00292"></a>00292                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot shutdown the writer stream"</span>,
+<a name="l00293"></a>00293                                                 errno);
+<a name="l00294"></a>00294                                 }
+<a name="l00295"></a>00295                         }
+<a name="l00296"></a>00296                 }
+<a name="l00297"></a>00297                 
+<a name="l00298"></a>00298                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> closeStream() {
+<a name="l00299"></a>00299                         TRACE_POINT();
+<a name="l00300"></a>00300                         <span class="keywordflow">if</span> (fd != -1) {
+<a name="l00301"></a>00301                                 <span class="keywordtype">int</span> ret = syscalls::close(fd);
+<a name="l00302"></a>00302                                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00303"></a>00303                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot close the session stream"</span>,
+<a name="l00304"></a>00304                                                 errno);
+<a name="l00305"></a>00305                                 }
+<a name="l00306"></a>00306                                 fd = -1;
+<a name="l00307"></a>00307                         }
+<a name="l00308"></a>00308                 }
 <a name="l00309"></a>00309                 
-<a name="l00310"></a>00310                 <span class="keywordflow">if</span> (ownerPipe != -1) {
-<a name="l00311"></a>00311                         <span class="keywordflow">do</span> {
-<a name="l00312"></a>00312                                 ret = close(ownerPipe);
-<a name="l00313"></a>00313                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
-<a name="l00314"></a>00314                 }
-<a name="l00315"></a>00315                 <span class="keywordflow">if</span> (!usingAbstractNamespace) {
-<a name="l00316"></a>00316                         <span class="keywordflow">do</span> {
-<a name="l00317"></a>00317                                 ret = unlink(listenSocketName.c_str());
-<a name="l00318"></a>00318                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
-<a name="l00319"></a>00319                 }
-<a name="l00320"></a>00320                 P_TRACE(3, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": destroyed."</span>);
-<a name="l00321"></a>00321         }
-<a name="l00322"></a>00322         <span class="comment"></span>
-<a name="l00323"></a>00323 <span class="comment">        /**</span>
-<a name="l00324"></a>00324 <span class="comment">         * Returns the application root for this application. See the constructor</span>
-<a name="l00325"></a>00325 <span class="comment">         * for information about the application root.</span>
-<a name="l00326"></a>00326 <span class="comment">         */</span>
-<a name="l00327"></a><a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56">00327</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this application.">getAppRoot</a>()<span class="keyword"> const </span>{
-<a name="l00328"></a>00328                 <span class="keywordflow">return</span> appRoot;
-<a name="l00329"></a>00329         }
-<a name="l00330"></a>00330         <span class="comment"></span>
-<a name="l00331"></a>00331 <span class="comment">        /**</span>
-<a name="l00332"></a>00332 <span class="comment">         * Returns the process ID of this application instance.</span>
-<a name="l00333"></a>00333 <span class="comment">         */</span>
-<a name="l00334"></a><a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02">00334</a>         pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{
-<a name="l00335"></a>00335                 <span class="keywordflow">return</span> pid;
-<a name="l00336"></a>00336         }
-<a name="l00337"></a>00337         <span class="comment"></span>
-<a name="l00338"></a>00338 <span class="comment">        /**</span>
-<a name="l00339"></a>00339 <span class="comment">         * Connect to this application instance with the purpose of sending</span>
-<a name="l00340"></a>00340 <span class="comment">         * a request to the application. Once connected, a new session will</span>
-<a name="l00341"></a>00341 <span class="comment">         * be opened. This session represents the life time of a single</span>
-<a name="l00342"></a>00342 <span class="comment">         * request/response pair, and can be used to send the request</span>
-<a name="l00343"></a>00343 <span class="comment">         * data to the application instance, as well as receiving the response</span>
-<a name="l00344"></a>00344 <span class="comment">         * data.</span>
-<a name="l00345"></a>00345 <span class="comment">         *</span>
-<a name="l00346"></a>00346 <span class="comment">         * The use of connect() is demonstrated in the following example.</span>
-<a name="l00347"></a>00347 <span class="comment">         * @code</span>
-<a name="l00348"></a>00348 <span class="comment">         *   // Connect to the application and get the newly opened session.</span>
-<a name="l00349"></a>00349 <span class="comment">         *   Application::SessionPtr session(app-&gt;connect("/home/webapps/foo"));</span>
-<a name="l00350"></a>00350 <span class="comment">         *   </span>
-<a name="l00351"></a>00351 <span class="comment">         *   // Send the request headers and request body data.</span>
-<a name="l00352"></a>00352 <span class="comment">         *   session-&gt;sendHeaders(...);</span>
-<a name="l00353"></a>00353 <span class="comment">         *   session-&gt;sendBodyBlock(...);</span>
-<a name="l00354"></a>00354 <span class="comment">         *   // Done sending data, so we close the writer channel.</span>
-<a name="l00355"></a>00355 <span class="comment">         *   session-&gt;closeWriter();</span>
-<a name="l00356"></a>00356 <span class="comment">         *</span>
-<a name="l00357"></a>00357 <span class="comment">         *   // Now read the HTTP response.</span>
-<a name="l00358"></a>00358 <span class="comment">         *   string responseData = readAllDataFromSocket(session-&gt;getReader());</span>
-<a name="l00359"></a>00359 <span class="comment">         *   // Done reading data, so we close the reader channel.</span>
-<a name="l00360"></a>00360 <span class="comment">         *   session-&gt;closeReader();</span>
-<a name="l00361"></a>00361 <span class="comment">         *</span>
-<a name="l00362"></a>00362 <span class="comment">         *   // This session has now finished, so we close the session by resetting</span>
-<a name="l00363"></a>00363 <span class="comment">         *   // the smart pointer to NULL (thereby destroying the Session object).</span>
-<a name="l00364"></a>00364 <span class="comment">         *   session.reset();</span>
-<a name="l00365"></a>00365 <span class="comment">         *</span>
-<a name="l00366"></a>00366 <span class="comment">         *   // We can connect to an Application multiple times. Just make sure</span>
-<a name="l00367"></a>00367 <span class="comment">         *   // the previous session is closed.</span>
-<a name="l00368"></a>00368 <span class="comment">         *   session = app-&gt;connect("/home/webapps/bar")</span>
-<a name="l00369"></a>00369 <span class="comment">         * @endcode</span>
-<a name="l00370"></a>00370 <span class="comment">         *</span>
-<a name="l00371"></a>00371 <span class="comment">         * Note that a RoR application instance can only process one</span>
-<a name="l00372"></a>00372 <span class="comment">         * request at the same time, and thus only one session at the same time.</span>
-<a name="l00373"></a>00373 <span class="comment">         * It's unspecified whether Rack applications can handle multiple simultanous sessions.</span>
-<a name="l00374"></a>00374 <span class="comment">         *</span>
-<a name="l00375"></a>00375 <span class="comment">         * You &lt;b&gt;must&lt;/b&gt; close a session when you no longer need if. If you</span>
-<a name="l00376"></a>00376 <span class="comment">         * call connect() without having properly closed a previous session,</span>
-<a name="l00377"></a>00377 <span class="comment">         * you might cause a deadlock because the application instance may be</span>
-<a name="l00378"></a>00378 <span class="comment">         * waiting for you to close the previous session.</span>
-<a name="l00379"></a>00379 <span class="comment">         *</span>
-<a name="l00380"></a>00380 <span class="comment">         * @return A smart pointer to a Session object, which represents the created session.</span>
-<a name="l00381"></a>00381 <span class="comment">         * @param closeCallback A function which will be called when the session has been closed.</span>
-<a name="l00382"></a>00382 <span class="comment">         * @post this-&gt;getSessions() == old-&gt;getSessions() + 1</span>
-<a name="l00383"></a>00383 <span class="comment">         * @throws SystemException Something went wrong during the connection process.</span>
-<a name="l00384"></a>00384 <span class="comment">         * @throws IOException Something went wrong during the connection process.</span>
-<a name="l00385"></a>00385 <span class="comment">         */</span>
-<a name="l00386"></a><a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379">00386</a>         <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> <a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the...">connect</a>(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback)<span class="keyword"> const </span>{
-<a name="l00387"></a>00387                 <span class="keywordtype">int</span> fd, ret;
-<a name="l00388"></a>00388                 
-<a name="l00389"></a>00389                 <span class="keywordflow">do</span> {
-<a name="l00390"></a>00390                         fd = socket(PF_UNIX, SOCK_STREAM, 0);
-<a name="l00391"></a>00391                 } <span class="keywordflow">while</span> (fd == -1 &amp;&amp; errno == EINTR);
-<a name="l00392"></a>00392                 <span class="keywordflow">if</span> (fd == -1) {
-<a name="l00393"></a>00393                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot create a new unconnected Unix socket"</span>, errno);
-<a name="l00394"></a>00394                 }
-<a name="l00395"></a>00395                 
-<a name="l00396"></a>00396                 <span class="keyword">struct </span>sockaddr_un addr;
-<a name="l00397"></a>00397                 addr.sun_family = AF_UNIX;
-<a name="l00398"></a>00398                 <span class="keywordflow">if</span> (usingAbstractNamespace) {
-<a name="l00399"></a>00399                         strncpy(addr.sun_path + 1, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path) - 1);
-<a name="l00400"></a>00400                         addr.sun_path[0] = <span class="charliteral">'\0'</span>;
-<a name="l00401"></a>00401                 } <span class="keywordflow">else</span> {
-<a name="l00402"></a>00402                         strncpy(addr.sun_path, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path));
-<a name="l00403"></a>00403                 }
-<a name="l00404"></a>00404                 addr.sun_path[<span class="keyword">sizeof</span>(addr.sun_path) - 1] = <span class="charliteral">'\0'</span>;
-<a name="l00405"></a>00405                 <span class="keywordflow">do</span> {
-<a name="l00406"></a>00406                         ret =<a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the..."> ::connect</a>(fd, (<span class="keyword">const</span> sockaddr *) &amp;addr, <span class="keyword">sizeof</span>(addr));
-<a name="l00407"></a>00407                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
-<a name="l00408"></a>00408                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00409"></a>00409                         <span class="keywordtype">int</span> e = errno;
-<a name="l00410"></a>00410                         <span class="keywordtype">string</span> message(<span class="stringliteral">"Cannot connect to Unix socket '"</span>);
-<a name="l00411"></a>00411                         message.append(listenSocketName);
-<a name="l00412"></a>00412                         message.append(<span class="stringliteral">"' on the abstract namespace"</span>);
-<a name="l00413"></a>00413                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(message, e);
-<a name="l00414"></a>00414                 }
-<a name="l00415"></a>00415                 
-<a name="l00416"></a>00416                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> StandardSession(pid, closeCallback, fd));
-<a name="l00417"></a>00417         }
-<a name="l00418"></a>00418 };
-<a name="l00419"></a>00419 <span class="comment"></span>
-<a name="l00420"></a>00420 <span class="comment">/** Convenient alias for Application smart pointer. */</span>
-<a name="l00421"></a><a class="code" href="namespacePassenger.html#6a15fd5e8765802a0b8b077e15297e18">00421</a> <span class="keyword">typedef</span> shared_ptr&lt;Application&gt; <a class="code" href="namespacePassenger.html#6a15fd5e8765802a0b8b077e15297e18" title="Convenient alias for Application smart pointer.">ApplicationPtr</a>;
-<a name="l00422"></a>00422 
-<a name="l00423"></a>00423 } <span class="comment">// namespace Passenger</span>
-<a name="l00424"></a>00424 
-<a name="l00425"></a>00425 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_APPLICATION_H_ */</span>
+<a name="l00310"></a>00310                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> discardStream() {
+<a name="l00311"></a>00311                         fd = -1;
+<a name="l00312"></a>00312                 }
+<a name="l00313"></a>00313                 
+<a name="l00314"></a>00314                 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{
+<a name="l00315"></a>00315                         <span class="keywordflow">return</span> pid;
+<a name="l00316"></a>00316                 }
+<a name="l00317"></a>00317         };
+<a name="l00318"></a>00318 
+<a name="l00319"></a>00319         <span class="keywordtype">string</span> appRoot;
+<a name="l00320"></a>00320         pid_t pid;
+<a name="l00321"></a>00321         <span class="keywordtype">string</span> listenSocketName;
+<a name="l00322"></a>00322         <span class="keywordtype">string</span> listenSocketType;
+<a name="l00323"></a>00323         <span class="keywordtype">int</span> ownerPipe;
+<a name="l00324"></a>00324         
+<a name="l00325"></a>00325         <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> connectToUnixServer(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback)<span class="keyword"> const </span>{
+<a name="l00326"></a>00326                 TRACE_POINT();
+<a name="l00327"></a>00327                 <span class="keywordtype">int</span> fd, ret;
+<a name="l00328"></a>00328                 
+<a name="l00329"></a>00329                 <span class="keywordflow">do</span> {
+<a name="l00330"></a>00330                         fd = socket(PF_UNIX, SOCK_STREAM, 0);
+<a name="l00331"></a>00331                 } <span class="keywordflow">while</span> (fd == -1 &amp;&amp; errno == EINTR);
+<a name="l00332"></a>00332                 <span class="keywordflow">if</span> (fd == -1) {
+<a name="l00333"></a>00333                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot create a new unconnected Unix socket"</span>, errno);
+<a name="l00334"></a>00334                 }
+<a name="l00335"></a>00335                 
+<a name="l00336"></a>00336                 <span class="keyword">struct </span>sockaddr_un addr;
+<a name="l00337"></a>00337                 addr.sun_family = AF_UNIX;
+<a name="l00338"></a>00338                 strncpy(addr.sun_path, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path));
+<a name="l00339"></a>00339                 addr.sun_path[<span class="keyword">sizeof</span>(addr.sun_path) - 1] = <span class="charliteral">'\0'</span>;
+<a name="l00340"></a>00340                 <span class="keywordflow">do</span> {
+<a name="l00341"></a>00341                         ret =<a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the..."> ::connect</a>(fd, (<span class="keyword">const</span> sockaddr *) &amp;addr, <span class="keyword">sizeof</span>(addr));
+<a name="l00342"></a>00342                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00343"></a>00343                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00344"></a>00344                         <span class="keywordtype">int</span> e = errno;
+<a name="l00345"></a>00345                         <span class="keywordtype">string</span> message(<span class="stringliteral">"Cannot connect to Unix socket '"</span>);
+<a name="l00346"></a>00346                         message.append(listenSocketName);
+<a name="l00347"></a>00347                         message.append(<span class="stringliteral">"'"</span>);
+<a name="l00348"></a>00348                         <span class="keywordflow">do</span> {
+<a name="l00349"></a>00349                                 ret = close(fd);
+<a name="l00350"></a>00350                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00351"></a>00351                         <span class="keywordflow">throw</span> SystemException(message, e);
+<a name="l00352"></a>00352                 }
+<a name="l00353"></a>00353                 
+<a name="l00354"></a>00354                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> StandardSession(pid, closeCallback, fd));
+<a name="l00355"></a>00355         }
+<a name="l00356"></a>00356         
+<a name="l00357"></a>00357         <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> connectToTcpServer(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback)<span class="keyword"> const </span>{
+<a name="l00358"></a>00358                 TRACE_POINT();
+<a name="l00359"></a>00359                 <span class="keywordtype">int</span> fd, ret;
+<a name="l00360"></a>00360                 vector&lt;string&gt; args;
+<a name="l00361"></a>00361                 
+<a name="l00362"></a>00362                 <a class="code" href="group__Support.html#g4b8320aedc6a164a535c920234e3d8bf" title="Split the given string using the given separator.">split</a>(listenSocketName, <span class="charliteral">':'</span>, args);
+<a name="l00363"></a>00363                 <span class="keywordflow">if</span> (args.size() != 2 || <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[1]) == 0) {
+<a name="l00364"></a>00364                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">"Invalid TCP/IP address '"</span> + listenSocketName + <span class="stringliteral">"'"</span>);
+<a name="l00365"></a>00365                 }
+<a name="l00366"></a>00366                 
+<a name="l00367"></a>00367                 <span class="keyword">struct </span>addrinfo hints, *res;
+<a name="l00368"></a>00368                 
+<a name="l00369"></a>00369                 memset(&amp;hints, 0, <span class="keyword">sizeof</span>(hints));
+<a name="l00370"></a>00370                 hints.ai_family = PF_INET;
+<a name="l00371"></a>00371                 hints.ai_socktype = SOCK_STREAM;
+<a name="l00372"></a>00372                 ret = getaddrinfo(args[0].c_str(), args[1].c_str(), &amp;hints, &amp;res);
+<a name="l00373"></a>00373                 <span class="keywordflow">if</span> (ret != 0) {
+<a name="l00374"></a>00374                         <span class="keywordtype">int</span> e = errno;
+<a name="l00375"></a>00375                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">"Cannot resolve address '"</span> + listenSocketName +
+<a name="l00376"></a>00376                                 <span class="stringliteral">"': "</span> + gai_strerror(e));
+<a name="l00377"></a>00377                 }
+<a name="l00378"></a>00378                 
+<a name="l00379"></a>00379                 <span class="keywordflow">do</span> {
+<a name="l00380"></a>00380                         fd = socket(PF_INET, SOCK_STREAM, 0);
+<a name="l00381"></a>00381                 } <span class="keywordflow">while</span> (fd == -1 &amp;&amp; errno == EINTR);
+<a name="l00382"></a>00382                 <span class="keywordflow">if</span> (fd == -1) {
+<a name="l00383"></a>00383                         freeaddrinfo(res);
+<a name="l00384"></a>00384                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot create a new unconnected TCP socket"</span>, errno);
+<a name="l00385"></a>00385                 }
+<a name="l00386"></a>00386                 
+<a name="l00387"></a>00387                 <span class="keywordflow">do</span> {
+<a name="l00388"></a>00388                         ret =<a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the..."> ::connect</a>(fd, res-&gt;ai_addr, res-&gt;ai_addrlen);
+<a name="l00389"></a>00389                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00390"></a>00390                 freeaddrinfo(res);
+<a name="l00391"></a>00391                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00392"></a>00392                         <span class="keywordtype">int</span> e = errno;
+<a name="l00393"></a>00393                         <span class="keywordtype">string</span> message(<span class="stringliteral">"Cannot connect to TCP server '"</span>);
+<a name="l00394"></a>00394                         message.append(listenSocketName);
+<a name="l00395"></a>00395                         message.append(<span class="stringliteral">"'"</span>);
+<a name="l00396"></a>00396                         <span class="keywordflow">do</span> {
+<a name="l00397"></a>00397                                 ret = close(fd);
+<a name="l00398"></a>00398                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00399"></a>00399                         <span class="keywordflow">throw</span> SystemException(message, e);
+<a name="l00400"></a>00400                 }
+<a name="l00401"></a>00401                 
+<a name="l00402"></a>00402                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> StandardSession(pid, closeCallback, fd));
+<a name="l00403"></a>00403         }
+<a name="l00404"></a>00404 
+<a name="l00405"></a>00405 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00406"></a>00406 <span class="comment">        /**</span>
+<a name="l00407"></a>00407 <span class="comment">         * Construct a new Application object.</span>
+<a name="l00408"></a>00408 <span class="comment">         *</span>
+<a name="l00409"></a>00409 <span class="comment">         * @param theAppRoot The application root of an application. In case of a Rails application,</span>
+<a name="l00410"></a>00410 <span class="comment">         *             this is the folder that contains 'app/', 'public/', 'config/', etc.</span>
+<a name="l00411"></a>00411 <span class="comment">         *             This must be a valid directory, but the path does not have to be absolute.</span>
+<a name="l00412"></a>00412 <span class="comment">         * @param pid The process ID of this application instance.</span>
+<a name="l00413"></a>00413 <span class="comment">         * @param listenSocketName The name of the listener socket of this application instance.</span>
+<a name="l00414"></a>00414 <span class="comment">         * @param listenSocketType The type of the listener socket, e.g. "unix" for Unix</span>
+<a name="l00415"></a>00415 <span class="comment">         *                         domain sockets.</span>
+<a name="l00416"></a>00416 <span class="comment">         * @param ownerPipe The owner pipe of this application instance.</span>
+<a name="l00417"></a>00417 <span class="comment">         * @post getAppRoot() == theAppRoot &amp;&amp; getPid() == pid</span>
+<a name="l00418"></a>00418 <span class="comment">         */</span>
+<a name="l00419"></a><a class="code" href="classPassenger_1_1Application.html#0ae83471a8c991b8cc8d460b44d237ea">00419</a>         <a class="code" href="classPassenger_1_1Application.html#0ae83471a8c991b8cc8d460b44d237ea" title="Construct a new Application object.">Application</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;theAppRoot, pid_t pid, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;listenSocketName,
+<a name="l00420"></a>00420                     <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;listenSocketType, <span class="keywordtype">int</span> ownerPipe) {
+<a name="l00421"></a>00421                 appRoot = theAppRoot;
+<a name="l00422"></a>00422                 this-&gt;pid = pid;
+<a name="l00423"></a>00423                 this-&gt;listenSocketName = listenSocketName;
+<a name="l00424"></a>00424                 this-&gt;listenSocketType = listenSocketType;
+<a name="l00425"></a>00425                 this-&gt;ownerPipe = ownerPipe;
+<a name="l00426"></a>00426                 P_TRACE(3, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": created."</span>);
+<a name="l00427"></a>00427         }
+<a name="l00428"></a>00428         
+<a name="l00429"></a>00429         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails or Rack application instance.">Application</a>() {
+<a name="l00430"></a>00430                 TRACE_POINT();
+<a name="l00431"></a>00431                 <span class="keywordtype">int</span> ret;
+<a name="l00432"></a>00432                 
+<a name="l00433"></a>00433                 <span class="keywordflow">if</span> (ownerPipe != -1) {
+<a name="l00434"></a>00434                         <span class="keywordflow">do</span> {
+<a name="l00435"></a>00435                                 ret = close(ownerPipe);
+<a name="l00436"></a>00436                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00437"></a>00437                 }
+<a name="l00438"></a>00438                 <span class="keywordflow">if</span> (listenSocketType == <span class="stringliteral">"unix"</span>) {
+<a name="l00439"></a>00439                         <span class="keywordflow">do</span> {
+<a name="l00440"></a>00440                                 ret = unlink(listenSocketName.c_str());
+<a name="l00441"></a>00441                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00442"></a>00442                 }
+<a name="l00443"></a>00443                 P_TRACE(3, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": destroyed."</span>);
+<a name="l00444"></a>00444         }
+<a name="l00445"></a>00445         <span class="comment"></span>
+<a name="l00446"></a>00446 <span class="comment">        /**</span>
+<a name="l00447"></a>00447 <span class="comment">         * Returns the application root for this application. See the constructor</span>
+<a name="l00448"></a>00448 <span class="comment">         * for information about the application root.</span>
+<a name="l00449"></a>00449 <span class="comment">         */</span>
+<a name="l00450"></a><a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56">00450</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this application.">getAppRoot</a>()<span class="keyword"> const </span>{
+<a name="l00451"></a>00451                 <span class="keywordflow">return</span> appRoot;
+<a name="l00452"></a>00452         }
+<a name="l00453"></a>00453         <span class="comment"></span>
+<a name="l00454"></a>00454 <span class="comment">        /**</span>
+<a name="l00455"></a>00455 <span class="comment">         * Returns the process ID of this application instance.</span>
+<a name="l00456"></a>00456 <span class="comment">         */</span>
+<a name="l00457"></a><a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02">00457</a>         pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{
+<a name="l00458"></a>00458                 <span class="keywordflow">return</span> pid;
+<a name="l00459"></a>00459         }
+<a name="l00460"></a>00460         <span class="comment"></span>
+<a name="l00461"></a>00461 <span class="comment">        /**</span>
+<a name="l00462"></a>00462 <span class="comment">         * Connect to this application instance with the purpose of sending</span>
+<a name="l00463"></a>00463 <span class="comment">         * a request to the application. Once connected, a new session will</span>
+<a name="l00464"></a>00464 <span class="comment">         * be opened. This session represents the life time of a single</span>
+<a name="l00465"></a>00465 <span class="comment">         * request/response pair, and can be used to send the request</span>
+<a name="l00466"></a>00466 <span class="comment">         * data to the application instance, as well as receiving the response</span>
+<a name="l00467"></a>00467 <span class="comment">         * data.</span>
+<a name="l00468"></a>00468 <span class="comment">         *</span>
+<a name="l00469"></a>00469 <span class="comment">         * The use of connect() is demonstrated in the following example.</span>
+<a name="l00470"></a>00470 <span class="comment">         * @code</span>
+<a name="l00471"></a>00471 <span class="comment">         *   // Connect to the application and get the newly opened session.</span>
+<a name="l00472"></a>00472 <span class="comment">         *   Application::SessionPtr session(app-&gt;connect("/home/webapps/foo"));</span>
+<a name="l00473"></a>00473 <span class="comment">         *   </span>
+<a name="l00474"></a>00474 <span class="comment">         *   // Send the request headers and request body data.</span>
+<a name="l00475"></a>00475 <span class="comment">         *   session-&gt;sendHeaders(...);</span>
+<a name="l00476"></a>00476 <span class="comment">         *   session-&gt;sendBodyBlock(...);</span>
+<a name="l00477"></a>00477 <span class="comment">         *   // Done sending data, so we close the writer channel.</span>
+<a name="l00478"></a>00478 <span class="comment">         *   session-&gt;closeWriter();</span>
+<a name="l00479"></a>00479 <span class="comment">         *</span>
+<a name="l00480"></a>00480 <span class="comment">         *   // Now read the HTTP response.</span>
+<a name="l00481"></a>00481 <span class="comment">         *   string responseData = readAllDataFromSocket(session-&gt;getReader());</span>
+<a name="l00482"></a>00482 <span class="comment">         *   // Done reading data, so we close the reader channel.</span>
+<a name="l00483"></a>00483 <span class="comment">         *   session-&gt;closeReader();</span>
+<a name="l00484"></a>00484 <span class="comment">         *</span>
+<a name="l00485"></a>00485 <span class="comment">         *   // This session has now finished, so we close the session by resetting</span>
+<a name="l00486"></a>00486 <span class="comment">         *   // the smart pointer to NULL (thereby destroying the Session object).</span>
+<a name="l00487"></a>00487 <span class="comment">         *   session.reset();</span>
+<a name="l00488"></a>00488 <span class="comment">         *</span>
+<a name="l00489"></a>00489 <span class="comment">         *   // We can connect to an Application multiple times. Just make sure</span>
+<a name="l00490"></a>00490 <span class="comment">         *   // the previous session is closed.</span>
+<a name="l00491"></a>00491 <span class="comment">         *   session = app-&gt;connect("/home/webapps/bar")</span>
+<a name="l00492"></a>00492 <span class="comment">         * @endcode</span>
+<a name="l00493"></a>00493 <span class="comment">         *</span>
+<a name="l00494"></a>00494 <span class="comment">         * Note that a RoR application instance can only process one</span>
+<a name="l00495"></a>00495 <span class="comment">         * request at the same time, and thus only one session at the same time.</span>
+<a name="l00496"></a>00496 <span class="comment">         * It's unspecified whether Rack applications can handle multiple simultanous sessions.</span>
+<a name="l00497"></a>00497 <span class="comment">         *</span>
+<a name="l00498"></a>00498 <span class="comment">         * You &lt;b&gt;must&lt;/b&gt; close a session when you no longer need if. If you</span>
+<a name="l00499"></a>00499 <span class="comment">         * call connect() without having properly closed a previous session,</span>
+<a name="l00500"></a>00500 <span class="comment">         * you might cause a deadlock because the application instance may be</span>
+<a name="l00501"></a>00501 <span class="comment">         * waiting for you to close the previous session.</span>
+<a name="l00502"></a>00502 <span class="comment">         *</span>
+<a name="l00503"></a>00503 <span class="comment">         * @return A smart pointer to a Session object, which represents the created session.</span>
+<a name="l00504"></a>00504 <span class="comment">         * @param closeCallback A function which will be called when the session has been closed.</span>
+<a name="l00505"></a>00505 <span class="comment">         * @post this-&gt;getSessions() == old-&gt;getSessions() + 1</span>
+<a name="l00506"></a>00506 <span class="comment">         * @throws SystemException Something went wrong during the connection process.</span>
+<a name="l00507"></a>00507 <span class="comment">         * @throws IOException Something went wrong during the connection process.</span>
+<a name="l00508"></a>00508 <span class="comment">         */</span>
+<a name="l00509"></a><a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379">00509</a>         <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> <a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the...">connect</a>(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback)<span class="keyword"> const </span>{
+<a name="l00510"></a>00510                 TRACE_POINT();
+<a name="l00511"></a>00511                 <span class="keywordflow">if</span> (listenSocketType == <span class="stringliteral">"unix"</span>) {
+<a name="l00512"></a>00512                         <span class="keywordflow">return</span> connectToUnixServer(closeCallback);
+<a name="l00513"></a>00513                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (listenSocketType == <span class="stringliteral">"tcp"</span>) {
+<a name="l00514"></a>00514                         <span class="keywordflow">return</span> connectToTcpServer(closeCallback);
+<a name="l00515"></a>00515                 } <span class="keywordflow">else</span> {
+<a name="l00516"></a>00516                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unsupported socket type '"</span> + listenSocketType + <span class="stringliteral">"'"</span>);
+<a name="l00517"></a>00517                 }
+<a name="l00518"></a>00518         }
+<a name="l00519"></a>00519 };
+<a name="l00520"></a>00520 <span class="comment"></span>
+<a name="l00521"></a>00521 <span class="comment">/** Convenient alias for Application smart pointer. */</span>
+<a name="l00522"></a>00522 <span class="keyword">typedef</span> shared_ptr&lt;Application&gt; ApplicationPtr;
+<a name="l00523"></a>00523 
+<a name="l00524"></a>00524 } <span class="comment">// namespace Passenger</span>
+<a name="l00525"></a>00525 
+<a name="l00526"></a>00526 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_APPLICATION_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:24 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:32 2009 for Passenger by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
 </body>