passenger 2.0.6 → 2.1.2

data/doc/cxxapi/classPassenger_1_1ApplicationPoolServer-members.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -29,7 +28,7 @@
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1ApplicationPoolServer.html#18f77057cc28e7924a8f4d1397aa0468">connect</a>()</td><td><a class="el" href="classPassenger_1_1ApplicationPoolServer.html">Passenger::ApplicationPoolServer</a></td><td><code> [inline]</code></td></tr>
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1ApplicationPoolServer.html#b13957e32ae8ca36ba85f2e6ffefd5ce">detach</a>()</td><td><a class="el" href="classPassenger_1_1ApplicationPoolServer.html">Passenger::ApplicationPoolServer</a></td><td><code> [inline]</code></td></tr>
 </table></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:34 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/classPassenger_1_1ApplicationPoolServer.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -22,7 +21,7 @@
       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
     </ul>
   </div>
-  <div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1ApplicationPoolServer.html">ApplicationPoolServer</a>
+  <div class="navpath"><b>Passenger</b>::<a class="el" href="classPassenger_1_1ApplicationPoolServer.html">ApplicationPoolServer</a>
   </div>
 </div>
 <div class="contents">
@@ -68,7 +67,7 @@ Multi-process usage support for <a class="el" href="classPassenger_1_1Applicatio
 <p>
 The actual server is implemented in ApplicationPoolServerExecutable.cpp, this class is just a convenience class for starting/stopping the server executable and connecting to it.<p>
 In the past, the server logic itself was implemented in this class. This implies that the <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server ran inside the Apache process. This presented us with several problems:<ul>
-<li>Because of the usage of threads in the <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server, the Apache VM size would go way up. This gave people the (wrong) impression that <a class="el" href="namespacePassenger.html" title="Support for interruption of blocking system calls and C library calls.">Passenger</a> uses a lot of memory, or that it leaks memory.</li><li>Although it's not entirely confirmed, we suspect that it caused heap fragmentation as well. Apache allocates lots and lots of small objects on the heap, and <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server isn't exactly helping. This too gave people the (wrong) impression that <a class="el" href="namespacePassenger.html" title="Support for interruption of blocking system calls and C library calls.">Passenger</a> leaks memory.</li><li>It would unnecessarily bloat the VM size of Apache worker processes.</li><li>We had to resort to all kinds of tricks to make sure that fork()ing a process doesn't result in file descriptor leaks.</li><li>Despite everything, there was still a small chance that file descriptor leaks would occur, and this could not be fixed. The reason for this is that the Apache control process may call fork() right after the <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server has established a new connection with a client.</li></ul>
+<li>Because of the usage of threads in the <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server, the Apache VM size would go way up. This gave people the (wrong) impression that Passenger uses a lot of memory, or that it leaks memory.</li><li>Although it's not entirely confirmed, we suspect that it caused heap fragmentation as well. Apache allocates lots and lots of small objects on the heap, and <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server isn't exactly helping. This too gave people the (wrong) impression that Passenger leaks memory.</li><li>It would unnecessarily bloat the VM size of Apache worker processes.</li><li>We had to resort to all kinds of tricks to make sure that fork()ing a process doesn't result in file descriptor leaks.</li><li>Despite everything, there was still a small chance that file descriptor leaks would occur, and this could not be fixed. The reason for this is that the Apache control process may call fork() right after the <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server has established a new connection with a client.</li></ul>
 <p>
 Because of these problems, it was decided to split the <a class="el" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> server to a separate executable. This comes with no performance hit.<p>
 <h3>Anonymous server socket</h3>
@@ -218,7 +217,7 @@ This method may only be called once. The <a class="el" href="classPassenger_1_1A
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="ApplicationPoolServer_8h-source.html">ApplicationPoolServer.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:34 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/classPassenger_1_1Application_1_1Session-members.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -32,11 +31,13 @@
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669">sendBodyBlock</a>(const char *block, unsigned int size)</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [inline, virtual]</code></td></tr>
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360">sendHeaders</a>(const char *headers, unsigned int size)</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [inline, virtual]</code></td></tr>
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#4fee03667f626d68c565495bcb19771a">sendHeaders</a>(const string &amp;headers)</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [inline, virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#17b4b6e4c47ec8941a099e229d2944f2">setReaderTimeout</a>(unsigned int msec)=0</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [pure virtual]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#4236abbdf69e10ded00c756de24433e9">setWriterTimeout</a>(unsigned int msec)=0</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [pure virtual]</code></td></tr>
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#45ad442dc1f4e7b73782bb3395d9e97d">shutdownReader</a>()=0</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [pure virtual]</code></td></tr>
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#dff449398adb872c93a9572ae4b701fb">shutdownWriter</a>()=0</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [pure virtual]</code></td></tr>
   <tr class="memlist"><td><a class="el" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c">~Session</a>()</td><td><a class="el" href="classPassenger_1_1Application_1_1Session.html">Passenger::Application::Session</a></td><td><code> [inline, virtual]</code></td></tr>
 </table></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:34 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/classPassenger_1_1Application_1_1Session.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -22,7 +21,7 @@
       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
     </ul>
   </div>
-  <div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1Application.html">Application</a>::<a class="el" href="classPassenger_1_1Application_1_1Session.html">Session</a>
+  <div class="navpath"><b>Passenger</b>::<a class="el" href="classPassenger_1_1Application.html">Application</a>::<a class="el" href="classPassenger_1_1Application_1_1Session.html">Session</a>
   </div>
 </div>
 <div class="contents">
@@ -59,6 +58,12 @@ virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e">getStream</a> () const =0</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the I/O stream's file descriptor.  <a href="#2631b6d6b4927ec66b1f620df15d8c6e"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Application_1_1Session.html#17b4b6e4c47ec8941a099e229d2944f2">setReaderTimeout</a> (unsigned int msec)=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the timeout value for reading data from the I/O stream.  <a href="#17b4b6e4c47ec8941a099e229d2944f2"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Application_1_1Session.html#4236abbdf69e10ded00c756de24433e9">setWriterTimeout</a> (unsigned int msec)=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the timeout value for writing data from the I/O stream.  <a href="#4236abbdf69e10ded00c756de24433e9"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Application_1_1Session.html#45ad442dc1f4e7b73782bb3395d9e97d">shutdownReader</a> ()=0</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicate that we don't want to read data anymore from the I/O stream.  <a href="#45ad442dc1f4e7b73782bb3395d9e97d"></a><br></td></tr>
@@ -234,6 +239,72 @@ Get the I/O stream's file descriptor.
 This steam is full-duplex, and will be automatically closed upon Session's destruction, unless <a class="el" href="classPassenger_1_1Application_1_1Session.html#7f9ad70e75d21130d914d2134061c757" title="Discard the I/O stream&#39;s file descriptor, so that Session won&#39;t automatically...">discardStream()</a> is called.<p>
 <dl class="pre" compact><dt><b>Precondition:</b></dt><dd>The stream has not been fully closed. </dd></dl>
 
+</div>
+</div><p>
+<a class="anchor" name="17b4b6e4c47ec8941a099e229d2944f2"></a><!-- doxytag: member="Passenger::Application::Session::setReaderTimeout" ref="17b4b6e4c47ec8941a099e229d2944f2" args="(unsigned int msec)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void Passenger::Application::Session::setReaderTimeout           </td>
+          <td>(</td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>msec</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Set the timeout value for reading data from the I/O stream. 
+<p>
+If no data can be read within the timeout period, then the read call will fail with error EAGAIN or EWOULDBLOCK.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>msec</em>&nbsp;</td><td>The timeout, in milliseconds. If 0 is given, there will be no timeout. </td></tr>
+  </table>
+</dl>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Cannot set the timeout. </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="4236abbdf69e10ded00c756de24433e9"></a><!-- doxytag: member="Passenger::Application::Session::setWriterTimeout" ref="4236abbdf69e10ded00c756de24433e9" args="(unsigned int msec)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual void Passenger::Application::Session::setWriterTimeout           </td>
+          <td>(</td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>msec</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Set the timeout value for writing data from the I/O stream. 
+<p>
+If no data can be written within the timeout period, then the write call will fail with error EAGAIN or EWOULDBLOCK.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>msec</em>&nbsp;</td><td>The timeout, in milliseconds. If 0 is given, there will be no timeout. </td></tr>
+  </table>
+</dl>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Cannot set the timeout. </td></tr>
+  </table>
+</dl>
+
 </div>
 </div><p>
 <a class="anchor" name="45ad442dc1f4e7b73782bb3395d9e97d"></a><!-- doxytag: member="Passenger::Application::Session::shutdownReader" ref="45ad442dc1f4e7b73782bb3395d9e97d" args="()=0" -->
@@ -322,7 +393,7 @@ Close the I/O stream.
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="Application_8h-source.html">Application.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:34 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/classPassenger_1_1BusyException-members.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -26,7 +25,7 @@
 <div class="contents">
 <h1>Passenger::BusyException Member List</h1>This is the complete list of members for <a class="el" href="classPassenger_1_1BusyException.html">Passenger::BusyException</a>, including all inherited members.<p><table>
 </table></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:35 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/classPassenger_1_1BusyException.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -22,7 +21,7 @@
       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
     </ul>
   </div>
-  <div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1BusyException.html">BusyException</a>
+  <div class="navpath"><b>Passenger</b>::<a class="el" href="classPassenger_1_1BusyException.html">BusyException</a>
   </div>
 </div>
 <div class="contents">
@@ -40,7 +39,7 @@ The application pool is too busy and cannot fulfill a get() request. <table bord
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="Exceptions_8h-source.html">Exceptions.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:35 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/classPassenger_1_1ConfigurationException-members.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -26,7 +25,7 @@
 <div class="contents">
 <h1>Passenger::ConfigurationException Member List</h1>This is the complete list of members for <a class="el" href="classPassenger_1_1ConfigurationException.html">Passenger::ConfigurationException</a>, including all inherited members.<p><table>
 </table></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:35 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/classPassenger_1_1ConfigurationException.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -22,7 +21,7 @@
       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
     </ul>
   </div>
-  <div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1ConfigurationException.html">ConfigurationException</a>
+  <div class="navpath"><b>Passenger</b>::<a class="el" href="classPassenger_1_1ConfigurationException.html">ConfigurationException</a>
   </div>
 </div>
 <div class="contents">
@@ -37,7 +36,7 @@ Thrown when an invalid configuration is given. <table border="0" cellpadding="0"
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="Exceptions_8h-source.html">Exceptions.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 15 15:27:25 2008 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:35 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/classPassenger_1_1DirectoryMapper-members.html

@@ -0,0 +1,38 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Passenger: Member List</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.5 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>Passenger::DirectoryMapper Member List</h1>This is the complete list of members for <a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a>, including all inherited members.<p><table>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1DirectoryMapper.html#e2725c3280a5e5d63dbc099fe3c3d82a">DirectoryMapper</a>(request_rec *r, DirConfig *config, CachedMultiFileStat *mstat, unsigned int throttleRate)</td><td><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1DirectoryMapper.html#ba438d86ca263972a47540956bf11ec1">getApplicationType</a>()</td><td><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1DirectoryMapper.html#c46f0e74ffd05b7fe9924dd99a057cf7">getApplicationTypeString</a>()</td><td><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1DirectoryMapper.html#2da887c077fc2460dea204783470e821">getBaseURI</a>()</td><td><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1DirectoryMapper.html#f5091e3cef3878e160e5d3b2181d82fb">getEnvironment</a>()</td><td><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td><code> [inline]</code></td></tr>
+  <tr class="memlist"><td><a class="el" href="classPassenger_1_1DirectoryMapper.html#ef969f27622fb215990a870076648aa1">getPublicDirectory</a>()</td><td><a class="el" href="classPassenger_1_1DirectoryMapper.html">Passenger::DirectoryMapper</a></td><td><code> [inline]</code></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:34 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>
+</html>

data/doc/cxxapi/classPassenger_1_1DirectoryMapper.html

@@ -0,0 +1,256 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Passenger: Passenger::DirectoryMapper Class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.5 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+  <div class="navpath"><b>Passenger</b>::<a class="el" href="classPassenger_1_1DirectoryMapper.html">DirectoryMapper</a>
+  </div>
+</div>
+<div class="contents">
+<h1>Passenger::DirectoryMapper Class Reference<br>
+<small>
+[<a class="el" href="group__Core.html">Core Apache-related classes and functions</a>]</small>
+</h1><!-- doxytag: class="Passenger::DirectoryMapper" --><code>#include &lt;<a class="el" href="DirectoryMapper_8h-source.html">DirectoryMapper.h</a>&gt;</code>
+<p>
+
+<p>
+<a href="classPassenger_1_1DirectoryMapper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
+Utility class for determining URI-to-application directory mappings. 
+<p>
+Given a URI, it will determine whether that URI belongs to a Phusion Passenger-handled application, what the base URI of that application is, and what the associated 'public' directory is.<p>
+<dl class="note" compact><dt><b>Note:</b></dt><dd>This class is not thread-safe, but is reentrant. </dd></dl>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1DirectoryMapper.html#e2725c3280a5e5d63dbc099fe3c3d82a">DirectoryMapper</a> (request_rec *r, DirConfig *config, CachedMultiFileStat *mstat, unsigned int throttleRate)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new <a class="el" href="classPassenger_1_1DirectoryMapper.html" title="Utility class for determining URI-to-application directory mappings.">DirectoryMapper</a> object.  <a href="#e2725c3280a5e5d63dbc099fe3c3d82a"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1DirectoryMapper.html#2da887c077fc2460dea204783470e821">getBaseURI</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine whether the given HTTP request falls under one of the specified RailsBaseURIs or RackBaseURIs.  <a href="#2da887c077fc2460dea204783470e821"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1DirectoryMapper.html#ef969f27622fb215990a870076648aa1">getPublicDirectory</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the filename of the 'public' directory of the Rails/Rack application that's associated with the HTTP request.  <a href="#ef969f27622fb215990a870076648aa1"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">ApplicationType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1DirectoryMapper.html#ba438d86ca263972a47540956bf11ec1">getApplicationType</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the application type that's associated with the HTTP request.  <a href="#ba438d86ca263972a47540956bf11ec1"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1DirectoryMapper.html#c46f0e74ffd05b7fe9924dd99a057cf7">getApplicationTypeString</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the application type (as a string) that's associated with the HTTP request.  <a href="#c46f0e74ffd05b7fe9924dd99a057cf7"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1DirectoryMapper.html#f5091e3cef3878e160e5d3b2181d82fb">getEnvironment</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the environment under which the application should be spawned.  <a href="#f5091e3cef3878e160e5d3b2181d82fb"></a><br></td></tr>
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="e2725c3280a5e5d63dbc099fe3c3d82a"></a><!-- doxytag: member="Passenger::DirectoryMapper::DirectoryMapper" ref="e2725c3280a5e5d63dbc099fe3c3d82a" args="(request_rec *r, DirConfig *config, CachedMultiFileStat *mstat, unsigned int throttleRate)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Passenger::DirectoryMapper::DirectoryMapper           </td>
+          <td>(</td>
+          <td class="paramtype">request_rec *&nbsp;</td>
+          <td class="paramname"> <em>r</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">DirConfig *&nbsp;</td>
+          <td class="paramname"> <em>config</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CachedMultiFileStat *&nbsp;</td>
+          <td class="paramname"> <em>mstat</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>throttleRate</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Create a new <a class="el" href="classPassenger_1_1DirectoryMapper.html" title="Utility class for determining URI-to-application directory mappings.">DirectoryMapper</a> object. 
+<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>mstat</em>&nbsp;</td><td>A CachedMultiFileStat object used for statting files. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>throttleRate</em>&nbsp;</td><td>A throttling rate for mstat. </td></tr>
+  </table>
+</dl>
+<dl class="warning" compact><dt><b>Warning:</b></dt><dd>Do not use this object after the destruction of <code>r</code>, <code>config</code> or <code>mstat</code>. </dd></dl>
+
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="2da887c077fc2460dea204783470e821"></a><!-- doxytag: member="Passenger::DirectoryMapper::getBaseURI" ref="2da887c077fc2460dea204783470e821" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* Passenger::DirectoryMapper::getBaseURI           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Determine whether the given HTTP request falls under one of the specified RailsBaseURIs or RackBaseURIs. 
+<p>
+If yes, then the first matching base URI will be returned.<p>
+If Rails/Rack autodetection was enabled in the configuration, and the document root seems to be a valid Rails/Rack 'public' folder, then this method will return "/".<p>
+Otherwise, NULL will be returned.<p>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>This method might also examine the filesystem in order to detect the application's type. During that process, a <a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a> might be thrown. </td></tr>
+  </table>
+</dl>
+<dl class="warning" compact><dt><b>Warning:</b></dt><dd>The return value may only be used as long as <code>config</code> hasn't been destroyed. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="ef969f27622fb215990a870076648aa1"></a><!-- doxytag: member="Passenger::DirectoryMapper::getPublicDirectory" ref="ef969f27622fb215990a870076648aa1" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">string Passenger::DirectoryMapper::getPublicDirectory           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the filename of the 'public' directory of the Rails/Rack application that's associated with the HTTP request. 
+<p>
+Returns an empty string if the document root of the HTTP request cannot be determined, or if it isn't a valid folder.<p>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>An error occured while examening the filesystem. </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="ba438d86ca263972a47540956bf11ec1"></a><!-- doxytag: member="Passenger::DirectoryMapper::getApplicationType" ref="ba438d86ca263972a47540956bf11ec1" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">ApplicationType Passenger::DirectoryMapper::getApplicationType           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the application type that's associated with the HTTP request. 
+<p>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>An error occured while examening the filesystem. </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="c46f0e74ffd05b7fe9924dd99a057cf7"></a><!-- doxytag: member="Passenger::DirectoryMapper::getApplicationTypeString" ref="c46f0e74ffd05b7fe9924dd99a057cf7" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* Passenger::DirectoryMapper::getApplicationTypeString           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the application type (as a string) that's associated with the HTTP request. 
+<p>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>An error occured while examening the filesystem. </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="f5091e3cef3878e160e5d3b2181d82fb"></a><!-- doxytag: member="Passenger::DirectoryMapper::getEnvironment" ref="f5091e3cef3878e160e5d3b2181d82fb" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* Passenger::DirectoryMapper::getEnvironment           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Returns the environment under which the application should be spawned. 
+<p>
+<dl compact><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>An error occured while examening the filesystem. </td></tr>
+  </table>
+</dl>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="DirectoryMapper_8h-source.html">DirectoryMapper.h</a></ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 13 19:24:34 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>
+</html>