passenger 2.2.15 → 3.0.0.pre1

data/doc/cxxapi/group__Support.html

@@ -13,6 +13,7 @@
     <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><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -20,7 +21,515 @@
 </div>
 <div class="contents">
 <h1>Apache-independent support classes and function</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Classes</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1AbstractSpawnManager.html">Passenger::AbstractSpawnManager</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Spawning of application processes.  <a href="classPassenger_1_1AbstractSpawnManager.html#_details">More...</a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1MessageChannel.html">Passenger::MessageChannel</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience class for I/O operations on file descriptors.  <a href="classPassenger_1_1MessageChannel.html#_details">More...</a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1MessageServer.html">Passenger::MessageServer</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple pluggable request/response messaging server framework.  <a href="classPassenger_1_1MessageServer.html#_details">More...</a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Process.html">Passenger::Process</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents a single application process, as spawned by <a class="el" href="classPassenger_1_1SpawnManager.html" title="An AbstractSpawnManager implementation.">SpawnManager</a> or by ApplicationPool::Interface::get().  <a href="classPassenger_1_1Process.html#_details">More...</a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1SpawnManager.html">Passenger::SpawnManager</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An <a class="el" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> implementation.  <a href="classPassenger_1_1SpawnManager.html#_details">More...</a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1BufferedUpload.html">Passenger::BufferedUpload</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents a buffered upload file.  <a href="classPassenger_1_1BufferedUpload.html#_details">More...</a><br/></td></tr>
+<tr><td colspan="2"><h2>Functions</h2></td></tr>
+<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
+<tr><td class="memTemplItemLeft" align="right" valign="top">shared_ptr&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396">Passenger::ptr</a> (T *pointer)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience shortcut for creating a <code>shared_ptr</code>.  <a href="#ga41b6c4a82fed72531a147de0505a8396"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#ga2a62e38a72c6c65992e3361f6d80c7ef">Passenger::fileExists</a> (const StaticString &amp;filename, CachedFileStat *cstat=0, unsigned int throttleRate=0)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether the specified file exists.  <a href="#ga2a62e38a72c6c65992e3361f6d80c7ef"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">FileType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#ga15298b031377d3ecb80295bd5b1a8180">Passenger::getFileType</a> (const StaticString &amp;filename, CachedFileStat *cstat=0, unsigned int throttleRate=0)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether 'filename' exists and what kind of file it is.  <a href="#ga15298b031377d3ecb80295bd5b1a8180"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#ga6f414070373465da2e12947463f69953">Passenger::createFile</a> (const string &amp;filename, const StaticString &amp;contents, mode_t permissions=S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH, uid_t owner=USER_NOT_GIVEN, gid_t group=GROUP_NOT_GIVEN, bool overwrite=true)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create the given file with the given contents, permissions and ownership.  <a href="#ga6f414070373465da2e12947463f69953"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#gaf3b0a483f0a252ae08d9de9f8b267d36">Passenger::canonicalizePath</a> (const string &amp;path)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a canonical version of the specified path.  <a href="#gaf3b0a483f0a252ae08d9de9f8b267d36"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#gac3d2b3d608188527d888e63d22c5163c">Passenger::resolveSymlink</a> (const string &amp;path)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If <em>path</em> refers to a symlink, then this function resolves the symlink for 1 level.  <a href="#gac3d2b3d608188527d888e63d22c5163c"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae651ece5281f22dc5fc974079f7c9187"></a><!-- doxytag: member="Support::extractDirName" ref="gae651ece5281f22dc5fc974079f7c9187" args="(const StaticString &amp;path)" -->
+string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#gae651ece5281f22dc5fc974079f7c9187">Passenger::extractDirName</a> (const StaticString &amp;path)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Given a path, extracts its directory name. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeb750234207485fa57609174ca8d4359"></a><!-- doxytag: member="Support::extractBaseName" ref="gaeb750234207485fa57609174ca8d4359" args="(const StaticString &amp;path)" -->
+string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#gaeb750234207485fa57609174ca8d4359">Passenger::extractBaseName</a> (const StaticString &amp;path)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Given a path, extracts its base name. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#gae74addedf73782a1eb1f6dd48d6fce06">Passenger::escapeForXml</a> (const string &amp;input)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Escape the given raw string into an XML value.  <a href="#gae74addedf73782a1eb1f6dd48d6fce06"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#ga68f4105c5a8e510520b5ea3eecb66213">Passenger::getSystemTempDir</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the path name for the directory in which the system stores general temporary files.  <a href="#ga68f4105c5a8e510520b5ea3eecb66213"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#ga5e6bc7ff22b7c61238d7913521936f71">Passenger::verifyRailsDir</a> (const string &amp;dir, CachedFileStat *cstat=0, unsigned int throttleRate=0)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether the specified directory is a valid Ruby on Rails application root directory.  <a href="#ga5e6bc7ff22b7c61238d7913521936f71"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#ga53969f8e3ee68d1d99ffe75af8db9be8">Passenger::verifyRackDir</a> (const string &amp;dir, CachedFileStat *cstat=0, unsigned int throttleRate=0)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether the specified directory is a valid Rack application root directory.  <a href="#ga53969f8e3ee68d1d99ffe75af8db9be8"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Support.html#gaaec51d2912999d611994c49341f36247">Passenger::verifyWSGIDir</a> (const string &amp;dir, CachedFileStat *cstat=0, unsigned int throttleRate=0)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether the specified directory is a valid WSGI application root directory.  <a href="#gaaec51d2912999d611994c49341f36247"></a><br/></td></tr>
 </table>
+<hr/><h2>Function Documentation</h2>
+<a class="anchor" id="gaf3b0a483f0a252ae08d9de9f8b267d36"></a><!-- doxytag: member="Passenger::canonicalizePath" ref="gaf3b0a483f0a252ae08d9de9f8b267d36" args="(const string &amp;path)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">string Passenger::canonicalizePath </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>path</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Returns a canonical version of the specified path. </p>
+<p>All symbolic links and relative path elements are resolved.</p>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ga6f414070373465da2e12947463f69953"></a><!-- doxytag: member="Passenger::createFile" ref="ga6f414070373465da2e12947463f69953" args="(const string &amp;filename, const StaticString &amp;contents, mode_t permissions=S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH, uid_t owner=USER_NOT_GIVEN, gid_t group=GROUP_NOT_GIVEN, bool overwrite=true)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Passenger::createFile </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>filename</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const StaticString &amp;&nbsp;</td>
+          <td class="paramname"> <em>contents</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">mode_t&nbsp;</td>
+          <td class="paramname"> <em>permissions</em> = <code>S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uid_t&nbsp;</td>
+          <td class="paramname"> <em>owner</em> = <code>USER_NOT_GIVEN</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">gid_t&nbsp;</td>
+          <td class="paramname"> <em>group</em> = <code>GROUP_NOT_GIVEN</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&nbsp;</td>
+          <td class="paramname"> <em>overwrite</em> = <code>true</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Create the given file with the given contents, permissions and ownership. </p>
+<p>This function does not leave behind junk files: if the ownership cannot be set or if not all data can be written then then the file will be deleted.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The file to create. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>contents</em>&nbsp;</td><td>The contents to write to the file. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>permissions</em>&nbsp;</td><td>The desired file permissions. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>owner</em>&nbsp;</td><td>The desired file owner. Specify USER_NOT_GIVEN if you want to use the current process's owner as the file owner. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>The desired file group. Specify GROUP_NOT_GIVEN if you want to use the current process's group as the file group. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>overwrite</em>&nbsp;</td><td>Whether to overwrite the file if it exists. If set to false and the file exists then nothing will happen. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="gae74addedf73782a1eb1f6dd48d6fce06"></a><!-- doxytag: member="Passenger::escapeForXml" ref="gae74addedf73782a1eb1f6dd48d6fce06" args="(const string &amp;input)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">string Passenger::escapeForXml </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>input</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Escape the given raw string into an XML value. </p>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>std::bad_alloc</em>&nbsp;</td><td>Something went wrong. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ga2a62e38a72c6c65992e3361f6d80c7ef"></a><!-- doxytag: member="Passenger::fileExists" ref="ga2a62e38a72c6c65992e3361f6d80c7ef" args="(const StaticString &amp;filename, CachedFileStat *cstat=0, unsigned int throttleRate=0)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Passenger::fileExists </td>
+          <td>(</td>
+          <td class="paramtype">const StaticString &amp;&nbsp;</td>
+          <td class="paramname"> <em>filename</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CachedFileStat *&nbsp;</td>
+          <td class="paramname"> <em>cstat</em> = <code>0</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>throttleRate</em> = <code>0</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Check whether the specified file exists. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The filename to check. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>cstat</em>&nbsp;</td><td>A CachedFileStat object, if you want to use cached statting. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>throttleRate</em>&nbsp;</td><td>A throttle rate for cstat. Only applicable if cstat is not NULL. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Whether the file exists. </dd></dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Unable to check because of a filesystem error. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a></em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ga15298b031377d3ecb80295bd5b1a8180"></a><!-- doxytag: member="Passenger::getFileType" ref="ga15298b031377d3ecb80295bd5b1a8180" args="(const StaticString &amp;filename, CachedFileStat *cstat=0, unsigned int throttleRate=0)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">FileType Passenger::getFileType </td>
+          <td>(</td>
+          <td class="paramtype">const StaticString &amp;&nbsp;</td>
+          <td class="paramname"> <em>filename</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CachedFileStat *&nbsp;</td>
+          <td class="paramname"> <em>cstat</em> = <code>0</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>throttleRate</em> = <code>0</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Check whether 'filename' exists and what kind of file it is. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The filename to check. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>mstat</em>&nbsp;</td><td>A CachedFileStat object, if you want to use cached statting. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>throttleRate</em>&nbsp;</td><td>A throttle rate for cstat. Only applicable if cstat is not NULL. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>The file type. </dd></dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Unable to check because of a filesystem error. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a></em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ga68f4105c5a8e510520b5ea3eecb66213"></a><!-- doxytag: member="Passenger::getSystemTempDir" ref="ga68f4105c5a8e510520b5ea3eecb66213" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char * Passenger::getSystemTempDir </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Return the path name for the directory in which the system stores general temporary files. </p>
+<p>This is usually "/tmp", but might be something else depending on some environment variables.</p>
+<p>result != NULL </p>
+
+</div>
+</div>
+<a class="anchor" id="ga41b6c4a82fed72531a147de0505a8396"></a><!-- doxytag: member="Passenger::ptr" ref="ga41b6c4a82fed72531a147de0505a8396" args="(T *pointer)" -->
+<div class="memitem">
+<div class="memproto">
+<div class="memtemplate">
+template&lt;typename T &gt; </div>
+      <table class="memname">
+        <tr>
+          <td class="memname">shared_ptr&lt;T&gt; Passenger::ptr </td>
+          <td>(</td>
+          <td class="paramtype">T *&nbsp;</td>
+          <td class="paramname"> <em>pointer</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Convenience shortcut for creating a <code>shared_ptr</code>. </p>
+<p>Instead of: </p>
+<div class="fragment"><pre class="fragment">    shared_ptr&lt;Foo&gt; foo;
+    ...
+    foo = shared_ptr&lt;Foo&gt;(<span class="keyword">new</span> Foo());
+</pre></div><p> one can write: </p>
+<div class="fragment"><pre class="fragment">    shared_ptr&lt;Foo&gt; foo;
+    ...
+    foo = <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> Foo());
+</pre></div><dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>pointer</em>&nbsp;</td><td>The item to put in the shared_ptr object. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="gac3d2b3d608188527d888e63d22c5163c"></a><!-- doxytag: member="Passenger::resolveSymlink" ref="gac3d2b3d608188527d888e63d22c5163c" args="(const string &amp;path)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">string Passenger::resolveSymlink </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>path</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>If <em>path</em> refers to a symlink, then this function resolves the symlink for 1 level. </p>
+<p>That is, if the symlink points to another symlink, then the other symlink will not be resolved. The resolved path is returned.</p>
+<p>If the symlink doesn't point to an absolute path, then this function will prepend <em>path</em>'s directory to the result.</p>
+<p>If <em>path</em> doesn't refer to a symlink then this method will return <em>path</em>.</p>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ga53969f8e3ee68d1d99ffe75af8db9be8"></a><!-- doxytag: member="Passenger::verifyRackDir" ref="ga53969f8e3ee68d1d99ffe75af8db9be8" args="(const string &amp;dir, CachedFileStat *cstat=0, unsigned int throttleRate=0)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Passenger::verifyRackDir </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>dir</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CachedFileStat *&nbsp;</td>
+          <td class="paramname"> <em>cstat</em> = <code>0</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>throttleRate</em> = <code>0</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Check whether the specified directory is a valid Rack application root directory. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>cstat</em>&nbsp;</td><td>A CachedFileStat object, if you want to use cached statting. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>throttleRate</em>&nbsp;</td><td>A throttle rate for cstat. Only applicable if cstat is not NULL. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Unable to check because of a filesystem error. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a></em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ga5e6bc7ff22b7c61238d7913521936f71"></a><!-- doxytag: member="Passenger::verifyRailsDir" ref="ga5e6bc7ff22b7c61238d7913521936f71" args="(const string &amp;dir, CachedFileStat *cstat=0, unsigned int throttleRate=0)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Passenger::verifyRailsDir </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>dir</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CachedFileStat *&nbsp;</td>
+          <td class="paramname"> <em>cstat</em> = <code>0</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>throttleRate</em> = <code>0</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Check whether the specified directory is a valid Ruby on Rails application root directory. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>cstat</em>&nbsp;</td><td>A CachedFileStat object, if you want to use cached statting. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>throttleRate</em>&nbsp;</td><td>A throttle rate for cstat. Only applicable if cstat is not NULL. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Unable to check because of a system error. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a></em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="gaaec51d2912999d611994c49341f36247"></a><!-- doxytag: member="Passenger::verifyWSGIDir" ref="gaaec51d2912999d611994c49341f36247" args="(const string &amp;dir, CachedFileStat *cstat=0, unsigned int throttleRate=0)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Passenger::verifyWSGIDir </td>
+          <td>(</td>
+          <td class="paramtype">const string &amp;&nbsp;</td>
+          <td class="paramname"> <em>dir</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CachedFileStat *&nbsp;</td>
+          <td class="paramname"> <em>cstat</em> = <code>0</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&nbsp;</td>
+          <td class="paramname"> <em>throttleRate</em> = <code>0</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Check whether the specified directory is a valid WSGI application root directory. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>cstat</em>&nbsp;</td><td>A CachedFileStat object, if you want to use cached statting. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>throttleRate</em>&nbsp;</td><td>A throttle rate for cstat. Only applicable if cstat is not NULL. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl><dt><b>Exceptions:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a></em>&nbsp;</td><td>Unable to check because of a filesystem error. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a></em>&nbsp;</td><td></td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
 </div>
 <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
 <a href="http://www.doxygen.org/index.html">