passenger 2.2.11 → 2.2.12

data/doc/cxxapi/Process_8h-source.html

@@ -97,175 +97,186 @@
 <a name="l00075"></a>00075         <span class="keywordtype">int</span> ownerPipe;
 <a name="l00076"></a>00076         <span class="keywordtype">string</span> detachKey;
 <a name="l00077"></a>00077         <span class="keywordtype">string</span> connectPassword;
-<a name="l00078"></a>00078         SocketInfoMap serverSockets;
-<a name="l00079"></a>00079         SocketInfo *mainServerSocket;
-<a name="l00080"></a>00080         function&lt;void ()&gt; destructionCallback;
-<a name="l00081"></a>00081         
-<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">         * Construct a new Process object.</span>
-<a name="l00085"></a>00085 <span class="comment">         *</span>
-<a name="l00086"></a>00086 <span class="comment">         * @param appRoot The application root of an application.</span>
-<a name="l00087"></a>00087 <span class="comment">         *             This must be a valid directory, but the path does not have to be absolute.</span>
-<a name="l00088"></a>00088 <span class="comment">         * @param pid The process ID of this application process.</span>
-<a name="l00089"></a>00089 <span class="comment">         * @param ownerPipe The owner pipe of this application process.</span>
-<a name="l00090"></a>00090 <span class="comment">         * @param serverSockets All the server sockets that this process listens on.</span>
-<a name="l00091"></a>00091 <span class="comment">         *                      There must a server socket with the name 'main'.</span>
-<a name="l00092"></a>00092 <span class="comment">         * @param detachKey A detach key. Used by the ApplicationPool algorithm.</span>
-<a name="l00093"></a>00093 <span class="comment">         * @param connectPassword The password to use when connecting to this process.</span>
-<a name="l00094"></a>00094 <span class="comment">         *                        Must be valid ASCII.</span>
-<a name="l00095"></a>00095 <span class="comment">         * @param destructionCallback A callback to be called when this Process is destroyed.</span>
-<a name="l00096"></a>00096 <span class="comment">         * @throws ArgumentException If serverSockets has no socket named 'main'.</span>
-<a name="l00097"></a>00097 <span class="comment">         */</span>
-<a name="l00098"></a><a class="code" href="classPassenger_1_1Process.html#cbc73466ae557c68cf040fcce925096c">00098</a>         <a class="code" href="classPassenger_1_1Process.html#cbc73466ae557c68cf040fcce925096c" title="Construct a new Process object.">Process</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;appRoot, pid_t pid, <span class="keywordtype">int</span> ownerPipe, <span class="keyword">const</span> SocketInfoMap &amp;serverSockets,
-<a name="l00099"></a>00099                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;detachKey, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;connectPassword,
-<a name="l00100"></a>00100                 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span> ()&gt; &amp;destructionCallback = function&lt;<span class="keywordtype">void</span> ()&gt;())
-<a name="l00101"></a>00101         {
-<a name="l00102"></a>00102                 this-&gt;appRoot         = appRoot;
-<a name="l00103"></a>00103                 this-&gt;pid             = pid;
-<a name="l00104"></a>00104                 this-&gt;ownerPipe       = ownerPipe;
-<a name="l00105"></a>00105                 this-&gt;serverSockets   = serverSockets;
-<a name="l00106"></a>00106                 this-&gt;detachKey       = detachKey;
-<a name="l00107"></a>00107                 this-&gt;connectPassword = connectPassword;
-<a name="l00108"></a>00108                 this-&gt;destructionCallback = destructionCallback;
-<a name="l00109"></a>00109                 <span class="keywordflow">if</span> (serverSockets.find(<span class="stringliteral">"main"</span>) == serverSockets.end()) {
-<a name="l00110"></a>00110                         TRACE_POINT();
-<a name="l00111"></a>00111                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1ArgumentException.html" title="Indicates that a specified argument is incorrect or violates a requirement.">ArgumentException</a>(<span class="stringliteral">"There must be a server socket named 'main'."</span>);
-<a name="l00112"></a>00112                 }
-<a name="l00113"></a>00113                 mainServerSocket = &amp;this-&gt;serverSockets[<span class="stringliteral">"main"</span>];
-<a name="l00114"></a>00114                 P_TRACE(3, <span class="stringliteral">"Application process "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": created."</span>);
-<a name="l00115"></a>00115         }
-<a name="l00116"></a>00116         
-<a name="l00117"></a>00117         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Process.html" title="Represents a single application process, as spawned by SpawnManager or by ApplicationPool::Interface...">Process</a>() {
-<a name="l00118"></a>00118                 TRACE_POINT();
-<a name="l00119"></a>00119                 SocketInfoMap::const_iterator it;
-<a name="l00120"></a>00120                 <span class="keywordtype">int</span> ret;
-<a name="l00121"></a>00121                 
-<a name="l00122"></a>00122                 <span class="keywordflow">if</span> (ownerPipe != -1) {
-<a name="l00123"></a>00123                         <span class="keywordflow">do</span> {
-<a name="l00124"></a>00124                                 ret = close(ownerPipe);
-<a name="l00125"></a>00125                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
-<a name="l00126"></a>00126                 }
-<a name="l00127"></a>00127                 <span class="keywordflow">for</span> (it = serverSockets.begin(); it != serverSockets.end(); it++) {
-<a name="l00128"></a>00128                         <span class="keyword">const</span> SocketInfo &amp;info = it-&gt;second;
-<a name="l00129"></a>00129                         <span class="keywordflow">if</span> (info.type == <span class="stringliteral">"unix"</span>) {
-<a name="l00130"></a>00130                                 <span class="keywordflow">do</span> {
-<a name="l00131"></a>00131                                         ret = unlink(info.address.c_str());
-<a name="l00132"></a>00132                                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
-<a name="l00133"></a>00133                         }
-<a name="l00134"></a>00134                 }
-<a name="l00135"></a>00135                 P_TRACE(3, <span class="stringliteral">"Application process "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": destroyed."</span>);
-<a name="l00136"></a>00136                 
-<a name="l00137"></a>00137                 <span class="keywordflow">if</span> (destructionCallback) {
-<a name="l00138"></a>00138                         destructionCallback();
-<a name="l00139"></a>00139                 }
-<a name="l00140"></a>00140         }
-<a name="l00141"></a>00141         <span class="comment"></span>
-<a name="l00142"></a>00142 <span class="comment">        /**</span>
-<a name="l00143"></a>00143 <span class="comment">         * Returns the application root for this application process. See</span>
-<a name="l00144"></a>00144 <span class="comment">         * the constructor for information about the application root.</span>
-<a name="l00145"></a>00145 <span class="comment">         */</span>
-<a name="l00146"></a><a class="code" href="classPassenger_1_1Process.html#ce9e949fa460ce09228cc08d76fc38e7">00146</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#ce9e949fa460ce09228cc08d76fc38e7" title="Returns the application root for this application process.">getAppRoot</a>()<span class="keyword"> const </span>{
-<a name="l00147"></a>00147                 <span class="keywordflow">return</span> appRoot;
-<a name="l00148"></a>00148         }
-<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">         * Returns the process ID of this application process.</span>
-<a name="l00152"></a>00152 <span class="comment">         */</span>
-<a name="l00153"></a><a class="code" href="classPassenger_1_1Process.html#fc1b82c05e963fee7e58445b152ca784">00153</a>         pid_t <a class="code" href="classPassenger_1_1Process.html#fc1b82c05e963fee7e58445b152ca784" title="Returns the process ID of this application process.">getPid</a>()<span class="keyword"> const </span>{
-<a name="l00154"></a>00154                 <span class="keywordflow">return</span> pid;
-<a name="l00155"></a>00155         }
-<a name="l00156"></a>00156         <span class="comment"></span>
-<a name="l00157"></a>00157 <span class="comment">        /**</span>
-<a name="l00158"></a>00158 <span class="comment">         * Returns this process's detach key.</span>
-<a name="l00159"></a>00159 <span class="comment">         */</span>
-<a name="l00160"></a><a class="code" href="classPassenger_1_1Process.html#308fa4c3bf80e4d3d48a3c833b9e3205">00160</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#308fa4c3bf80e4d3d48a3c833b9e3205" title="Returns this process&amp;#39;s detach key.">getDetachKey</a>()<span class="keyword"> const </span>{
-<a name="l00161"></a>00161                 <span class="keywordflow">return</span> detachKey;
-<a name="l00162"></a>00162         }
-<a name="l00163"></a>00163         <span class="comment"></span>
-<a name="l00164"></a>00164 <span class="comment">        /**</span>
-<a name="l00165"></a>00165 <span class="comment">         * Returns this process's connect password. This password is</span>
-<a name="l00166"></a>00166 <span class="comment">         * guaranteed to be valid ASCII.</span>
-<a name="l00167"></a>00167 <span class="comment">         */</span>
-<a name="l00168"></a><a class="code" href="classPassenger_1_1Process.html#002791d7909d4d7a6566eb26ec491552">00168</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#002791d7909d4d7a6566eb26ec491552" title="Returns this process&amp;#39;s connect password.">getConnectPassword</a>()<span class="keyword"> const </span>{
-<a name="l00169"></a>00169                 <span class="keywordflow">return</span> connectPassword;
-<a name="l00170"></a>00170         }
-<a name="l00171"></a>00171         <span class="comment"></span>
-<a name="l00172"></a>00172 <span class="comment">        /**</span>
-<a name="l00173"></a>00173 <span class="comment">         * Returns a map containing all server sockets that this process</span>
-<a name="l00174"></a>00174 <span class="comment">         * listens on.</span>
-<a name="l00175"></a>00175 <span class="comment">         */</span>
-<a name="l00176"></a><a class="code" href="classPassenger_1_1Process.html#fe06f5be540203452a5e787da15ee5e4">00176</a>         <span class="keyword">const</span> SocketInfoMap *<a class="code" href="classPassenger_1_1Process.html#fe06f5be540203452a5e787da15ee5e4" title="Returns a map containing all server sockets that this process listens on.">getServerSockets</a>()<span class="keyword"> const </span>{
-<a name="l00177"></a>00177                 <span class="keywordflow">return</span> &amp;serverSockets;
-<a name="l00178"></a>00178         }
-<a name="l00179"></a>00179         <span class="comment"></span>
-<a name="l00180"></a>00180 <span class="comment">        /**</span>
-<a name="l00181"></a>00181 <span class="comment">         * Request a new session from this application process by connecting to its</span>
-<a name="l00182"></a>00182 <span class="comment">         * main server socket. This session represents the life time of a single</span>
-<a name="l00183"></a>00183 <span class="comment">         * request/response pair, and can be used to send the request data to the</span>
-<a name="l00184"></a>00184 <span class="comment">         * application process, as well as receiving the response data.</span>
-<a name="l00185"></a>00185 <span class="comment">         *</span>
-<a name="l00186"></a>00186 <span class="comment">         * The use of connect() is demonstrated in the following example.</span>
-<a name="l00187"></a>00187 <span class="comment">         * @code</span>
-<a name="l00188"></a>00188 <span class="comment">         *   // Request a new session from the process.</span>
-<a name="l00189"></a>00189 <span class="comment">         *   SessionPtr session = process-&gt;newSession(...);</span>
-<a name="l00190"></a>00190 <span class="comment">         *   </span>
-<a name="l00191"></a>00191 <span class="comment">         *   // Send the request headers and request body data.</span>
-<a name="l00192"></a>00192 <span class="comment">         *   session-&gt;sendHeaders(...);</span>
-<a name="l00193"></a>00193 <span class="comment">         *   session-&gt;sendBodyBlock(...);</span>
-<a name="l00194"></a>00194 <span class="comment">         *   // Done sending data, so we close the writer channel.</span>
-<a name="l00195"></a>00195 <span class="comment">         *   session-&gt;shutdownWriter();</span>
+<a name="l00078"></a>00078         <span class="keywordtype">string</span> gupid;
+<a name="l00079"></a>00079         SocketInfoMap serverSockets;
+<a name="l00080"></a>00080         SocketInfo *mainServerSocket;
+<a name="l00081"></a>00081         function&lt;void ()&gt; destructionCallback;
+<a name="l00082"></a>00082         
+<a name="l00083"></a>00083 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00084"></a>00084 <span class="comment">        /**</span>
+<a name="l00085"></a>00085 <span class="comment">         * Construct a new Process object.</span>
+<a name="l00086"></a>00086 <span class="comment">         *</span>
+<a name="l00087"></a>00087 <span class="comment">         * @param appRoot The application root of an application.</span>
+<a name="l00088"></a>00088 <span class="comment">         *             This must be a valid directory, but the path does not have to be absolute.</span>
+<a name="l00089"></a>00089 <span class="comment">         * @param pid The process ID of this application process.</span>
+<a name="l00090"></a>00090 <span class="comment">         * @param ownerPipe The owner pipe of this application process.</span>
+<a name="l00091"></a>00091 <span class="comment">         * @param serverSockets All the server sockets that this process listens on.</span>
+<a name="l00092"></a>00092 <span class="comment">         *                      There must a server socket with the name 'main'.</span>
+<a name="l00093"></a>00093 <span class="comment">         * @param detachKey A detach key. Used by the ApplicationPool algorithm.</span>
+<a name="l00094"></a>00094 <span class="comment">         * @param connectPassword The password to use when connecting to this process.</span>
+<a name="l00095"></a>00095 <span class="comment">         *                        Must be valid ASCII.</span>
+<a name="l00096"></a>00096 <span class="comment">         * @param gupid A string which uniquely identifies this process.</span>
+<a name="l00097"></a>00097 <span class="comment">         * @param destructionCallback A callback to be called when this Process is destroyed.</span>
+<a name="l00098"></a>00098 <span class="comment">         * @throws ArgumentException If serverSockets has no socket named 'main'.</span>
+<a name="l00099"></a>00099 <span class="comment">         */</span>
+<a name="l00100"></a><a class="code" href="classPassenger_1_1Process.html#52c89242f2ff9298f302b4e2f75aea8f">00100</a>         <a class="code" href="classPassenger_1_1Process.html#52c89242f2ff9298f302b4e2f75aea8f" title="Construct a new Process object.">Process</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;appRoot, pid_t pid, <span class="keywordtype">int</span> ownerPipe, <span class="keyword">const</span> SocketInfoMap &amp;serverSockets,
+<a name="l00101"></a>00101                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;detachKey, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;connectPassword, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;gupid,
+<a name="l00102"></a>00102                 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span> ()&gt; &amp;destructionCallback = function&lt;<span class="keywordtype">void</span> ()&gt;())
+<a name="l00103"></a>00103         {
+<a name="l00104"></a>00104                 this-&gt;appRoot         = appRoot;
+<a name="l00105"></a>00105                 this-&gt;pid             = pid;
+<a name="l00106"></a>00106                 this-&gt;ownerPipe       = ownerPipe;
+<a name="l00107"></a>00107                 this-&gt;serverSockets   = serverSockets;
+<a name="l00108"></a>00108                 this-&gt;detachKey       = detachKey;
+<a name="l00109"></a>00109                 this-&gt;connectPassword = connectPassword;
+<a name="l00110"></a>00110                 this-&gt;gupid           = gupid;
+<a name="l00111"></a>00111                 this-&gt;destructionCallback = destructionCallback;
+<a name="l00112"></a>00112                 <span class="keywordflow">if</span> (serverSockets.find(<span class="stringliteral">"main"</span>) == serverSockets.end()) {
+<a name="l00113"></a>00113                         TRACE_POINT();
+<a name="l00114"></a>00114                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1ArgumentException.html" title="Indicates that a specified argument is incorrect or violates a requirement.">ArgumentException</a>(<span class="stringliteral">"There must be a server socket named 'main'."</span>);
+<a name="l00115"></a>00115                 }
+<a name="l00116"></a>00116                 mainServerSocket = &amp;this-&gt;serverSockets[<span class="stringliteral">"main"</span>];
+<a name="l00117"></a>00117                 P_TRACE(3, <span class="stringliteral">"Application process "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": created."</span>);
+<a name="l00118"></a>00118         }
+<a name="l00119"></a>00119         
+<a name="l00120"></a>00120         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Process.html" title="Represents a single application process, as spawned by SpawnManager or by ApplicationPool::Interface...">Process</a>() {
+<a name="l00121"></a>00121                 TRACE_POINT();
+<a name="l00122"></a>00122                 SocketInfoMap::const_iterator it;
+<a name="l00123"></a>00123                 <span class="keywordtype">int</span> ret;
+<a name="l00124"></a>00124                 
+<a name="l00125"></a>00125                 <span class="keywordflow">if</span> (ownerPipe != -1) {
+<a name="l00126"></a>00126                         <span class="keywordflow">do</span> {
+<a name="l00127"></a>00127                                 ret = close(ownerPipe);
+<a name="l00128"></a>00128                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00129"></a>00129                 }
+<a name="l00130"></a>00130                 <span class="keywordflow">for</span> (it = serverSockets.begin(); it != serverSockets.end(); it++) {
+<a name="l00131"></a>00131                         <span class="keyword">const</span> SocketInfo &amp;info = it-&gt;second;
+<a name="l00132"></a>00132                         <span class="keywordflow">if</span> (info.type == <span class="stringliteral">"unix"</span>) {
+<a name="l00133"></a>00133                                 <span class="keywordflow">do</span> {
+<a name="l00134"></a>00134                                         ret = unlink(info.address.c_str());
+<a name="l00135"></a>00135                                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00136"></a>00136                         }
+<a name="l00137"></a>00137                 }
+<a name="l00138"></a>00138                 P_TRACE(3, <span class="stringliteral">"Application process "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": destroyed."</span>);
+<a name="l00139"></a>00139                 
+<a name="l00140"></a>00140                 <span class="keywordflow">if</span> (destructionCallback) {
+<a name="l00141"></a>00141                         destructionCallback();
+<a name="l00142"></a>00142                 }
+<a name="l00143"></a>00143         }
+<a name="l00144"></a>00144         <span class="comment"></span>
+<a name="l00145"></a>00145 <span class="comment">        /**</span>
+<a name="l00146"></a>00146 <span class="comment">         * Returns the application root for this application process. See</span>
+<a name="l00147"></a>00147 <span class="comment">         * the constructor for information about the application root.</span>
+<a name="l00148"></a>00148 <span class="comment">         */</span>
+<a name="l00149"></a><a class="code" href="classPassenger_1_1Process.html#ce9e949fa460ce09228cc08d76fc38e7">00149</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#ce9e949fa460ce09228cc08d76fc38e7" title="Returns the application root for this application process.">getAppRoot</a>()<span class="keyword"> const </span>{
+<a name="l00150"></a>00150                 <span class="keywordflow">return</span> appRoot;
+<a name="l00151"></a>00151         }
+<a name="l00152"></a>00152         <span class="comment"></span>
+<a name="l00153"></a>00153 <span class="comment">        /**</span>
+<a name="l00154"></a>00154 <span class="comment">         * Returns the process ID of this application process.</span>
+<a name="l00155"></a>00155 <span class="comment">         */</span>
+<a name="l00156"></a><a class="code" href="classPassenger_1_1Process.html#fc1b82c05e963fee7e58445b152ca784">00156</a>         pid_t <a class="code" href="classPassenger_1_1Process.html#fc1b82c05e963fee7e58445b152ca784" title="Returns the process ID of this application process.">getPid</a>()<span class="keyword"> const </span>{
+<a name="l00157"></a>00157                 <span class="keywordflow">return</span> pid;
+<a name="l00158"></a>00158         }
+<a name="l00159"></a>00159         <span class="comment"></span>
+<a name="l00160"></a>00160 <span class="comment">        /**</span>
+<a name="l00161"></a>00161 <span class="comment">         * Returns this process's detach key.</span>
+<a name="l00162"></a>00162 <span class="comment">         */</span>
+<a name="l00163"></a><a class="code" href="classPassenger_1_1Process.html#308fa4c3bf80e4d3d48a3c833b9e3205">00163</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#308fa4c3bf80e4d3d48a3c833b9e3205" title="Returns this process&amp;#39;s detach key.">getDetachKey</a>()<span class="keyword"> const </span>{
+<a name="l00164"></a>00164                 <span class="keywordflow">return</span> detachKey;
+<a name="l00165"></a>00165         }
+<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">         * Returns this process's connect password. This password is</span>
+<a name="l00169"></a>00169 <span class="comment">         * guaranteed to be valid ASCII.</span>
+<a name="l00170"></a>00170 <span class="comment">         */</span>
+<a name="l00171"></a><a class="code" href="classPassenger_1_1Process.html#002791d7909d4d7a6566eb26ec491552">00171</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#002791d7909d4d7a6566eb26ec491552" title="Returns this process&amp;#39;s connect password.">getConnectPassword</a>()<span class="keyword"> const </span>{
+<a name="l00172"></a>00172                 <span class="keywordflow">return</span> connectPassword;
+<a name="l00173"></a>00173         }
+<a name="l00174"></a>00174         <span class="comment"></span>
+<a name="l00175"></a>00175 <span class="comment">        /**</span>
+<a name="l00176"></a>00176 <span class="comment">         * Returns this process's gupid. This is like a PID, but does not rotate</span>
+<a name="l00177"></a>00177 <span class="comment">         * and is even unique over multiple servers.</span>
+<a name="l00178"></a>00178 <span class="comment">         */</span>
+<a name="l00179"></a><a class="code" href="classPassenger_1_1Process.html#6997775fdfa7c0d9e681102bd044c40b">00179</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Process.html#6997775fdfa7c0d9e681102bd044c40b" title="Returns this process&amp;#39;s gupid.">getGupid</a>()<span class="keyword"> const </span>{
+<a name="l00180"></a>00180                 <span class="keywordflow">return</span> gupid;
+<a name="l00181"></a>00181         }
+<a name="l00182"></a>00182         <span class="comment"></span>
+<a name="l00183"></a>00183 <span class="comment">        /**</span>
+<a name="l00184"></a>00184 <span class="comment">         * Returns a map containing all server sockets that this process</span>
+<a name="l00185"></a>00185 <span class="comment">         * listens on.</span>
+<a name="l00186"></a>00186 <span class="comment">         */</span>
+<a name="l00187"></a><a class="code" href="classPassenger_1_1Process.html#fe06f5be540203452a5e787da15ee5e4">00187</a>         <span class="keyword">const</span> SocketInfoMap *<a class="code" href="classPassenger_1_1Process.html#fe06f5be540203452a5e787da15ee5e4" title="Returns a map containing all server sockets that this process listens on.">getServerSockets</a>()<span class="keyword"> const </span>{
+<a name="l00188"></a>00188                 <span class="keywordflow">return</span> &amp;serverSockets;
+<a name="l00189"></a>00189         }
+<a name="l00190"></a>00190         <span class="comment"></span>
+<a name="l00191"></a>00191 <span class="comment">        /**</span>
+<a name="l00192"></a>00192 <span class="comment">         * Request a new session from this application process by connecting to its</span>
+<a name="l00193"></a>00193 <span class="comment">         * main server socket. This session represents the life time of a single</span>
+<a name="l00194"></a>00194 <span class="comment">         * request/response pair, and can be used to send the request data to the</span>
+<a name="l00195"></a>00195 <span class="comment">         * application process, as well as receiving the response data.</span>
 <a name="l00196"></a>00196 <span class="comment">         *</span>
-<a name="l00197"></a>00197 <span class="comment">         *   // Now read the HTTP response.</span>
-<a name="l00198"></a>00198 <span class="comment">         *   string responseData = readAllDataFromSocket(session-&gt;getReader());</span>
-<a name="l00199"></a>00199 <span class="comment">         *   // Done reading data, so we close the reader channel.</span>
-<a name="l00200"></a>00200 <span class="comment">         *   session-&gt;shutdownReader();</span>
-<a name="l00201"></a>00201 <span class="comment">         *</span>
-<a name="l00202"></a>00202 <span class="comment">         *   // This session has now finished, so we close the session by resetting</span>
-<a name="l00203"></a>00203 <span class="comment">         *   // the smart pointer to NULL (thereby destroying the Session object).</span>
-<a name="l00204"></a>00204 <span class="comment">         *   session.reset();</span>
-<a name="l00205"></a>00205 <span class="comment">         *</span>
-<a name="l00206"></a>00206 <span class="comment">         *   // We can connect to a Process multiple times. Just make sure</span>
-<a name="l00207"></a>00207 <span class="comment">         *   // the previous session is closed.</span>
-<a name="l00208"></a>00208 <span class="comment">         *   session = process-&gt;newSession(...);</span>
-<a name="l00209"></a>00209 <span class="comment">         * @endcode</span>
-<a name="l00210"></a>00210 <span class="comment">         *</span>
-<a name="l00211"></a>00211 <span class="comment">         * You &lt;b&gt;must&lt;/b&gt; close a session when you no longer need it. If you</span>
-<a name="l00212"></a>00212 <span class="comment">         * call connect() without having properly closed a previous session,</span>
-<a name="l00213"></a>00213 <span class="comment">         * you might cause a deadlock because the application process may be</span>
-<a name="l00214"></a>00214 <span class="comment">         * waiting for you to close the previous session.</span>
-<a name="l00215"></a>00215 <span class="comment">         *</span>
-<a name="l00216"></a>00216 <span class="comment">         * @param closeCallback A function which will be called when the session has been closed.</span>
-<a name="l00217"></a>00217 <span class="comment">         * @param initiateNow Whether the session should be initiated immediately.</span>
-<a name="l00218"></a>00218 <span class="comment">         *                    If set to false then you must call &lt;tt&gt;initiate()&lt;/tt&gt; on</span>
-<a name="l00219"></a>00219 <span class="comment">         *                    the session before it's usable.</span>
-<a name="l00220"></a>00220 <span class="comment">         * @return A smart pointer to a Session object, which represents the created session.</span>
-<a name="l00221"></a>00221 <span class="comment">         * @post result-&gt;initiated() == initiateNow</span>
-<a name="l00222"></a>00222 <span class="comment">         * @throws SystemException Something went wrong during session initiation.</span>
-<a name="l00223"></a>00223 <span class="comment">         * @throws IOException Something went wrong during session initiation.</span>
-<a name="l00224"></a>00224 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00225"></a>00225 <span class="comment">         */</span>
-<a name="l00226"></a><a class="code" href="classPassenger_1_1Process.html#a5bd9ad8220bf64e5edf3d025004547a">00226</a>         SessionPtr <a class="code" href="classPassenger_1_1Process.html#a5bd9ad8220bf64e5edf3d025004547a" title="Request a new session from this application process by connecting to its main server...">newSession</a>(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback = function&lt;<span class="keywordtype">void</span>()&gt;(),
-<a name="l00227"></a>00227                               <span class="keywordtype">bool</span> initiateNow = <span class="keyword">true</span>)
-<a name="l00228"></a>00228         {
-<a name="l00229"></a>00229                 SessionPtr session(<span class="keyword">new</span> <a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>(pid, closeCallback,
-<a name="l00230"></a>00230                         mainServerSocket-&gt;type, mainServerSocket-&gt;address,
-<a name="l00231"></a>00231                         detachKey, connectPassword));
-<a name="l00232"></a>00232                 <span class="keywordflow">if</span> (initiateNow) {
-<a name="l00233"></a>00233                         session-&gt;initiate();
-<a name="l00234"></a>00234                 }
-<a name="l00235"></a>00235                 <span class="keywordflow">return</span> session;
-<a name="l00236"></a>00236         }
-<a name="l00237"></a>00237 };
-<a name="l00238"></a>00238 <span class="comment"></span>
-<a name="l00239"></a>00239 <span class="comment">/** Convenient alias for Process smart pointer. */</span>
-<a name="l00240"></a><a class="code" href="namespacePassenger.html#ced1f248465136b313c6dec5fe6ca492">00240</a> <span class="keyword">typedef</span> shared_ptr&lt;Process&gt; <a class="code" href="namespacePassenger.html#ced1f248465136b313c6dec5fe6ca492" title="Convenient alias for Process smart pointer.">ProcessPtr</a>;
-<a name="l00241"></a>00241 
-<a name="l00242"></a>00242 } <span class="comment">// namespace Passenger</span>
-<a name="l00243"></a>00243 
-<a name="l00244"></a>00244 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_PROCESS_H_ */</span>
+<a name="l00197"></a>00197 <span class="comment">         * The use of connect() is demonstrated in the following example.</span>
+<a name="l00198"></a>00198 <span class="comment">         * @code</span>
+<a name="l00199"></a>00199 <span class="comment">         *   // Request a new session from the process.</span>
+<a name="l00200"></a>00200 <span class="comment">         *   SessionPtr session = process-&gt;newSession(...);</span>
+<a name="l00201"></a>00201 <span class="comment">         *   </span>
+<a name="l00202"></a>00202 <span class="comment">         *   // Send the request headers and request body data.</span>
+<a name="l00203"></a>00203 <span class="comment">         *   session-&gt;sendHeaders(...);</span>
+<a name="l00204"></a>00204 <span class="comment">         *   session-&gt;sendBodyBlock(...);</span>
+<a name="l00205"></a>00205 <span class="comment">         *   // Done sending data, so we close the writer channel.</span>
+<a name="l00206"></a>00206 <span class="comment">         *   session-&gt;shutdownWriter();</span>
+<a name="l00207"></a>00207 <span class="comment">         *</span>
+<a name="l00208"></a>00208 <span class="comment">         *   // Now read the HTTP response.</span>
+<a name="l00209"></a>00209 <span class="comment">         *   string responseData = readAllDataFromSocket(session-&gt;getReader());</span>
+<a name="l00210"></a>00210 <span class="comment">         *   // Done reading data, so we close the reader channel.</span>
+<a name="l00211"></a>00211 <span class="comment">         *   session-&gt;shutdownReader();</span>
+<a name="l00212"></a>00212 <span class="comment">         *</span>
+<a name="l00213"></a>00213 <span class="comment">         *   // This session has now finished, so we close the session by resetting</span>
+<a name="l00214"></a>00214 <span class="comment">         *   // the smart pointer to NULL (thereby destroying the Session object).</span>
+<a name="l00215"></a>00215 <span class="comment">         *   session.reset();</span>
+<a name="l00216"></a>00216 <span class="comment">         *</span>
+<a name="l00217"></a>00217 <span class="comment">         *   // We can connect to a Process multiple times. Just make sure</span>
+<a name="l00218"></a>00218 <span class="comment">         *   // the previous session is closed.</span>
+<a name="l00219"></a>00219 <span class="comment">         *   session = process-&gt;newSession(...);</span>
+<a name="l00220"></a>00220 <span class="comment">         * @endcode</span>
+<a name="l00221"></a>00221 <span class="comment">         *</span>
+<a name="l00222"></a>00222 <span class="comment">         * You &lt;b&gt;must&lt;/b&gt; close a session when you no longer need it. If you</span>
+<a name="l00223"></a>00223 <span class="comment">         * call connect() without having properly closed a previous session,</span>
+<a name="l00224"></a>00224 <span class="comment">         * you might cause a deadlock because the application process may be</span>
+<a name="l00225"></a>00225 <span class="comment">         * waiting for you to close the previous session.</span>
+<a name="l00226"></a>00226 <span class="comment">         *</span>
+<a name="l00227"></a>00227 <span class="comment">         * @param closeCallback A function which will be called when the session has been closed.</span>
+<a name="l00228"></a>00228 <span class="comment">         * @param initiateNow Whether the session should be initiated immediately.</span>
+<a name="l00229"></a>00229 <span class="comment">         *                    If set to false then you must call &lt;tt&gt;initiate()&lt;/tt&gt; on</span>
+<a name="l00230"></a>00230 <span class="comment">         *                    the session before it's usable.</span>
+<a name="l00231"></a>00231 <span class="comment">         * @return A smart pointer to a Session object, which represents the created session.</span>
+<a name="l00232"></a>00232 <span class="comment">         * @post result-&gt;initiated() == initiateNow</span>
+<a name="l00233"></a>00233 <span class="comment">         * @throws SystemException Something went wrong during session initiation.</span>
+<a name="l00234"></a>00234 <span class="comment">         * @throws IOException Something went wrong during session initiation.</span>
+<a name="l00235"></a>00235 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00236"></a>00236 <span class="comment">         */</span>
+<a name="l00237"></a><a class="code" href="classPassenger_1_1Process.html#4df3ce126ba64c864c1759d916f25635">00237</a>         SessionPtr <a class="code" href="classPassenger_1_1Process.html#4df3ce126ba64c864c1759d916f25635" title="Request a new session from this application process by connecting to its main server...">newSession</a>(<span class="keyword">const</span> StandardSession::CloseCallback &amp;closeCallback = StandardSession::CloseCallback(),
+<a name="l00238"></a>00238                               <span class="keywordtype">bool</span> initiateNow = <span class="keyword">true</span>)
+<a name="l00239"></a>00239         {
+<a name="l00240"></a>00240                 SessionPtr session(<span class="keyword">new</span> <a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>(pid, closeCallback,
+<a name="l00241"></a>00241                         mainServerSocket-&gt;type, mainServerSocket-&gt;address,
+<a name="l00242"></a>00242                         detachKey, connectPassword, gupid));
+<a name="l00243"></a>00243                 <span class="keywordflow">if</span> (initiateNow) {
+<a name="l00244"></a>00244                         session-&gt;initiate();
+<a name="l00245"></a>00245                 }
+<a name="l00246"></a>00246                 <span class="keywordflow">return</span> session;
+<a name="l00247"></a>00247         }
+<a name="l00248"></a>00248 };
+<a name="l00249"></a>00249 <span class="comment"></span>
+<a name="l00250"></a>00250 <span class="comment">/** Convenient alias for Process smart pointer. */</span>
+<a name="l00251"></a><a class="code" href="namespacePassenger.html#ced1f248465136b313c6dec5fe6ca492">00251</a> <span class="keyword">typedef</span> shared_ptr&lt;Process&gt; <a class="code" href="namespacePassenger.html#ced1f248465136b313c6dec5fe6ca492" title="Convenient alias for Process smart pointer.">ProcessPtr</a>;
+<a name="l00252"></a>00252 
+<a name="l00253"></a>00253 } <span class="comment">// namespace Passenger</span>
+<a name="l00254"></a>00254 
+<a name="l00255"></a>00255 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_PROCESS_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 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.8 </small></address>
 </body>

data/doc/cxxapi/RandomGenerator_8h-source.html

@@ -131,25 +131,52 @@
 <a name="l00109"></a>00109                 generateBytes(buf, size);
 <a name="l00110"></a>00110                 <span class="keywordflow">return</span> <a class="code" href="namespacePassenger.html#1d4b16a419fe7231bc8b7036266f8131" title="Convert the given binary data to hexadecimal.">toHex</a>(<a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>(buf, size));
 <a name="l00111"></a>00111         }
-<a name="l00112"></a>00112         
-<a name="l00113"></a>00113         <span class="keywordtype">int</span> generateInt() {
-<a name="l00114"></a>00114                 <span class="keywordtype">int</span> ret;
-<a name="l00115"></a>00115                 generateBytes(&amp;ret, <span class="keyword">sizeof</span>(ret));
-<a name="l00116"></a>00116                 <span class="keywordflow">return</span> ret;
-<a name="l00117"></a>00117         }
-<a name="l00118"></a>00118         
-<a name="l00119"></a>00119         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> generateUint() {
-<a name="l00120"></a>00120                 <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) generateInt();
-<a name="l00121"></a>00121         }
-<a name="l00122"></a>00122 };
-<a name="l00123"></a>00123 
-<a name="l00124"></a>00124 <span class="keyword">typedef</span> shared_ptr&lt;RandomGenerator&gt; RandomGeneratorPtr;
-<a name="l00125"></a>00125 
-<a name="l00126"></a>00126 } <span class="comment">// namespace Passenger</span>
-<a name="l00127"></a>00127 
-<a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_RANDOM_GENERATOR_H_ */</span>
+<a name="l00112"></a>00112         <span class="comment"></span>
+<a name="l00113"></a>00113 <span class="comment">        /**</span>
+<a name="l00114"></a>00114 <span class="comment">         * Generates a random string of &lt;em&gt;size&lt;/em&gt; bytes which is also</span>
+<a name="l00115"></a>00115 <span class="comment">         * valid ASCII. The result consists only of the characters A-Z,</span>
+<a name="l00116"></a>00116 <span class="comment">         * a-z and 0-9, and therefore the total number of possibilities</span>
+<a name="l00117"></a>00117 <span class="comment">         * given a size of N is 62**N. However not every character has an</span>
+<a name="l00118"></a>00118 <span class="comment">         * equal chance of being chosen: a-i have 5/256 chance of being</span>
+<a name="l00119"></a>00119 <span class="comment">         * chosen, while other characters have 4/256 chance of being chosen.</span>
+<a name="l00120"></a>00120 <span class="comment">         * Therefore, to match the entropy of a random binary string of</span>
+<a name="l00121"></a>00121 <span class="comment">         * size N, one should choose a &lt;em&gt;size&lt;/em&gt; which yields slightly</span>
+<a name="l00122"></a>00122 <span class="comment">         * more possibilities than 2**N.</span>
+<a name="l00123"></a>00123 <span class="comment">         */</span>
+<a name="l00124"></a><a class="code" href="classPassenger_1_1RandomGenerator.html#d9d9a489f6dbfabafb35da326f5ed967">00124</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1RandomGenerator.html#d9d9a489f6dbfabafb35da326f5ed967" title="Generates a random string of size bytes which is also valid ASCII.">generateAsciiString</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00125"></a>00125                 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> chars[] = {
+<a name="l00126"></a>00126                         <span class="charliteral">'a'</span>, <span class="charliteral">'b'</span>, <span class="charliteral">'c'</span>, <span class="charliteral">'d'</span>, <span class="charliteral">'e'</span>, <span class="charliteral">'f'</span>, <span class="charliteral">'g'</span>, <span class="charliteral">'h'</span>, <span class="charliteral">'i'</span>, <span class="charliteral">'j'</span>, <span class="charliteral">'k'</span>, <span class="charliteral">'l'</span>, <span class="charliteral">'m'</span>,
+<a name="l00127"></a>00127                         <span class="charliteral">'n'</span>, <span class="charliteral">'o'</span>, <span class="charliteral">'p'</span>, <span class="charliteral">'q'</span>, <span class="charliteral">'r'</span>, <span class="charliteral">'s'</span>, <span class="charliteral">'t'</span>, <span class="charliteral">'u'</span>, <span class="charliteral">'v'</span>, <span class="charliteral">'w'</span>, <span class="charliteral">'x'</span>, <span class="charliteral">'y'</span>, <span class="charliteral">'z'</span>,
+<a name="l00128"></a>00128                         <span class="charliteral">'A'</span>, <span class="charliteral">'B'</span>, <span class="charliteral">'C'</span>, <span class="charliteral">'D'</span>, <span class="charliteral">'E'</span>, <span class="charliteral">'F'</span>, <span class="charliteral">'G'</span>, <span class="charliteral">'H'</span>, <span class="charliteral">'I'</span>, <span class="charliteral">'J'</span>, <span class="charliteral">'K'</span>, <span class="charliteral">'L'</span>, <span class="charliteral">'M'</span>,
+<a name="l00129"></a>00129                         <span class="charliteral">'N'</span>, <span class="charliteral">'O'</span>, <span class="charliteral">'P'</span>, <span class="charliteral">'Q'</span>, <span class="charliteral">'R'</span>, <span class="charliteral">'S'</span>, <span class="charliteral">'T'</span>, <span class="charliteral">'U'</span>, <span class="charliteral">'V'</span>, <span class="charliteral">'W'</span>, <span class="charliteral">'X'</span>, <span class="charliteral">'Y'</span>, <span class="charliteral">'Z'</span>,
+<a name="l00130"></a>00130                         <span class="charliteral">'0'</span>, <span class="charliteral">'1'</span>, <span class="charliteral">'2'</span>, <span class="charliteral">'3'</span>, <span class="charliteral">'4'</span>, <span class="charliteral">'5'</span>, <span class="charliteral">'6'</span>, <span class="charliteral">'7'</span>, <span class="charliteral">'8'</span>, <span class="charliteral">'9'</span>
+<a name="l00131"></a>00131                 };
+<a name="l00132"></a>00132                 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> buf[size];
+<a name="l00133"></a>00133                 generateBytes(buf, size);
+<a name="l00134"></a>00134                 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; size; i++) {
+<a name="l00135"></a>00135                         buf[i] = chars[buf[i] % <span class="keyword">sizeof</span>(chars)];
+<a name="l00136"></a>00136                 }
+<a name="l00137"></a>00137                 <span class="keywordflow">return</span> string((<span class="keyword">const</span> <span class="keywordtype">char</span> *) buf, size);
+<a name="l00138"></a>00138         }
+<a name="l00139"></a>00139         
+<a name="l00140"></a>00140         <span class="keywordtype">int</span> generateInt() {
+<a name="l00141"></a>00141                 <span class="keywordtype">int</span> ret;
+<a name="l00142"></a>00142                 generateBytes(&amp;ret, <span class="keyword">sizeof</span>(ret));
+<a name="l00143"></a>00143                 <span class="keywordflow">return</span> ret;
+<a name="l00144"></a>00144         }
+<a name="l00145"></a>00145         
+<a name="l00146"></a>00146         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> generateUint() {
+<a name="l00147"></a>00147                 <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) generateInt();
+<a name="l00148"></a>00148         }
+<a name="l00149"></a>00149 };
+<a name="l00150"></a>00150 
+<a name="l00151"></a>00151 <span class="keyword">typedef</span> shared_ptr&lt;RandomGenerator&gt; RandomGeneratorPtr;
+<a name="l00152"></a>00152 
+<a name="l00153"></a>00153 } <span class="comment">// namespace Passenger</span>
+<a name="l00154"></a>00154 
+<a name="l00155"></a>00155 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_RANDOM_GENERATOR_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 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.8 </small></address>
 </body>

data/doc/cxxapi/ResourceLocator_8h-source.html

@@ -80,7 +80,7 @@
 <a name="l00058"></a>00058                 }
 <a name="l00059"></a>00059         }
 <a name="l00060"></a>00060         
-<a name="l00061"></a>00061         <span class="keywordtype">string</span> getHelperScriptDir()<span class="keyword"> const </span>{
+<a name="l00061"></a>00061         <span class="keywordtype">string</span> getHelperScriptsDir()<span class="keyword"> const </span>{
 <a name="l00062"></a>00062                 <span class="keywordflow">if</span> (nativelyPackaged) {
 <a name="l00063"></a>00063                         <span class="keywordflow">return</span> <span class="stringliteral">"/usr/share/phusion-passenger/helper-scripts"</span>;
 <a name="l00064"></a>00064                 } <span class="keywordflow">else</span> {
@@ -89,7 +89,7 @@
 <a name="l00067"></a>00067         }
 <a name="l00068"></a>00068         
 <a name="l00069"></a>00069         <span class="keywordtype">string</span> getSpawnServerFilename()<span class="keyword"> const </span>{
-<a name="l00070"></a>00070                 <span class="keywordflow">return</span> root + <span class="stringliteral">"/bin/passenger-spawn-server"</span>;
+<a name="l00070"></a>00070                 <span class="keywordflow">return</span> getHelperScriptsDir() + <span class="stringliteral">"/passenger-spawn-server"</span>;
 <a name="l00071"></a>00071         }
 <a name="l00072"></a>00072 };
 <a name="l00073"></a>00073 
@@ -97,7 +97,7 @@
 <a name="l00075"></a>00075 
 <a name="l00076"></a>00076 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_RESOURCE_LOCATOR_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 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.8 </small></address>
 </body>

data/doc/cxxapi/ScgiRequestParser_8h-source.html

@@ -49,350 +49,351 @@
 <a name="l00027"></a>00027 
 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;map&gt;</span>
-<a name="l00030"></a>00030 
-<a name="l00031"></a>00031 <span class="preprocessor">#include "StaticString.h"</span>
-<a name="l00032"></a>00032 
-<a name="l00033"></a>00033 <span class="keyword">namespace </span>Passenger {
-<a name="l00034"></a>00034 
-<a name="l00035"></a>00035 <span class="keyword">using namespace </span>std;
-<a name="l00036"></a>00036 <span class="keyword">using namespace </span>google;
-<a name="l00037"></a>00037 <span class="comment"></span>
-<a name="l00038"></a>00038 <span class="comment">/**</span>
-<a name="l00039"></a>00039 <span class="comment"> * A parser for SCGI requests. It parses the request header and ignores the</span>
-<a name="l00040"></a>00040 <span class="comment"> * body data.</span>
-<a name="l00041"></a>00041 <span class="comment"> *</span>
-<a name="l00042"></a>00042 <span class="comment"> * You can use it by constructing a parser object, then feeding data to the</span>
-<a name="l00043"></a>00043 <span class="comment"> * parser until it has reached a final state.</span>
-<a name="l00044"></a>00044 <span class="comment"> *</span>
-<a name="l00045"></a>00045 <span class="comment"> * Example:</span>
-<a name="l00046"></a>00046 <span class="comment"> * @code</span>
-<a name="l00047"></a>00047 <span class="comment"> *    ScgiRequestParser parser;</span>
-<a name="l00048"></a>00048 <span class="comment"> *    char buf[1024 * 16];</span>
-<a name="l00049"></a>00049 <span class="comment"> *    ssize_t size;</span>
-<a name="l00050"></a>00050 <span class="comment"> *    unsigned in bytesAccepted;</span>
-<a name="l00051"></a>00051 <span class="comment"> *    </span>
-<a name="l00052"></a>00052 <span class="comment"> *    do {</span>
-<a name="l00053"></a>00053 <span class="comment"> *        size = read(fd, buf, sizeof(buf));</span>
-<a name="l00054"></a>00054 <span class="comment"> *        bytesAccepted = parser.feed(buf, size);</span>
-<a name="l00055"></a>00055 <span class="comment"> *    } while (parser.acceptingInput());</span>
-<a name="l00056"></a>00056 <span class="comment"> *    // Parser is done when its return value isn't equal to the input size.</span>
-<a name="l00057"></a>00057 <span class="comment"> *    </span>
-<a name="l00058"></a>00058 <span class="comment"> *    // Check whether a parse error occured.</span>
-<a name="l00059"></a>00059 <span class="comment"> *    if (parser.getState() == ScgiRequestParser::ERROR) {</span>
-<a name="l00060"></a>00060 <span class="comment"> *        bailOut();</span>
-<a name="l00061"></a>00061 <span class="comment"> *    } else {</span>
-<a name="l00062"></a>00062 <span class="comment"> *        // All good! Do something with the SCGI header that the parser parsed.</span>
-<a name="l00063"></a>00063 <span class="comment"> *        processHeader(parser.getHeaderData());</span>
-<a name="l00064"></a>00064 <span class="comment"> *        </span>
-<a name="l00065"></a>00065 <span class="comment"> *        // If the last buffer passed to the parser also contains body data,</span>
-<a name="l00066"></a>00066 <span class="comment"> *        // then the body data starts at 'buf + bytesAccepted'.</span>
-<a name="l00067"></a>00067 <span class="comment"> *        if (bytesAccepted &lt; size) {</span>
-<a name="l00068"></a>00068 <span class="comment"> *            processBody(buf + bytesAccepted);</span>
-<a name="l00069"></a>00069 <span class="comment"> *        }</span>
-<a name="l00070"></a>00070 <span class="comment"> *        while (!end_of_file(fd)) {</span>
-<a name="l00071"></a>00071 <span class="comment"> *            ... read(...) ...</span>
-<a name="l00072"></a>00072 <span class="comment"> *            processBody(...);</span>
-<a name="l00073"></a>00073 <span class="comment"> *        }</span>
-<a name="l00074"></a>00074 <span class="comment"> *    }</span>
-<a name="l00075"></a>00075 <span class="comment"> * @endcode</span>
-<a name="l00076"></a>00076 <span class="comment"> *</span>
-<a name="l00077"></a>00077 <span class="comment"> * Parser properties:</span>
-<a name="l00078"></a>00078 <span class="comment"> * - A parser object can only process a single SCGI request. You must discard</span>
-<a name="l00079"></a>00079 <span class="comment"> *   the existing parser object and create a new one if you want to process</span>
-<a name="l00080"></a>00080 <span class="comment"> *   another SCGI request.</span>
-<a name="l00081"></a>00081 <span class="comment"> * - This parser checks whether the header netstring is valid. It will enter</span>
-<a name="l00082"></a>00082 <span class="comment"> *   the error state if it encounters a parse error.</span>
-<a name="l00083"></a>00083 <span class="comment"> * - However, this parser does not perform any validation of the actual header</span>
-<a name="l00084"></a>00084 <span class="comment"> *   contents. For example, it doesn't check that CONTENT_LENGTH is the first</span>
-<a name="l00085"></a>00085 <span class="comment"> *   header, or that the SCGI header is present.</span>
-<a name="l00086"></a>00086 <span class="comment"> */</span>
-<a name="l00087"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html">00087</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ScgiRequestParser.html" title="A parser for SCGI requests.">ScgiRequestParser</a> {
-<a name="l00088"></a>00088 <span class="keyword">public</span>:
-<a name="l00089"></a>00089         <span class="keyword">enum</span> State {
-<a name="l00090"></a>00090                 READING_LENGTH_STRING,
-<a name="l00091"></a>00091                 READING_HEADER_DATA,
-<a name="l00092"></a>00092                 EXPECTING_COMMA,
-<a name="l00093"></a>00093                 DONE,
-<a name="l00094"></a>00094                 ERROR
-<a name="l00095"></a>00095         };
-<a name="l00096"></a>00096         
-<a name="l00097"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">00097</a>         <span class="keyword">enum</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> {
-<a name="l00098"></a>00098                 NONE,
-<a name="l00099"></a>00099                 <span class="comment"></span>
-<a name="l00100"></a>00100 <span class="comment">                /** The length string is too large. */</span>
-<a name="l00101"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b">00101</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b" title="The length string is too large.">LENGTH_STRING_TOO_LARGE</a>,
-<a name="l00102"></a>00102                 <span class="comment"></span>
-<a name="l00103"></a>00103 <span class="comment">                /** The header is larger than the maxSize value provided to the constructor. */</span>
-<a name="l00104"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d">00104</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d" title="The header is larger than the maxSize value provided to the constructor.">LIMIT_REACHED</a>,
-<a name="l00105"></a>00105                 <span class="comment"></span>
-<a name="l00106"></a>00106 <span class="comment">                /** The length string contains an invalid character. */</span>
-<a name="l00107"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332">00107</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332" title="The length string contains an invalid character.">INVALID_LENGTH_STRING</a>,
-<a name="l00108"></a>00108                 <span class="comment"></span>
-<a name="l00109"></a>00109 <span class="comment">                /** A header terminator character (",") was expected, but some else</span>
-<a name="l00110"></a>00110 <span class="comment">                 * was encountered instead. */</span>
-<a name="l00111"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44">00111</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&amp;quot;,&amp;quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>,
-<a name="l00112"></a>00112                 <span class="comment"></span>
-<a name="l00113"></a>00113 <span class="comment">                /** The header data itself contains errors. */</span>
-<a name="l00114"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add">00114</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>
-<a name="l00115"></a>00115         };
-<a name="l00116"></a>00116         
-<a name="l00117"></a>00117 <span class="keyword">private</span>:
-<a name="l00118"></a>00118         <span class="keyword">typedef</span> dense_hash_map&lt;StaticString, StaticString, StaticString::Hash&gt; HeaderMap;
-<a name="l00119"></a>00119         
-<a name="l00120"></a>00120         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxSize;
-<a name="l00121"></a>00121         
-<a name="l00122"></a>00122         State state;
-<a name="l00123"></a>00123         <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> errorReason;
-<a name="l00124"></a>00124         <span class="keywordtype">char</span> lengthStringBuffer[<span class="keyword">sizeof</span>(<span class="stringliteral">"4294967296"</span>)];
-<a name="l00125"></a>00125         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lengthStringBufferSize;
-<a name="l00126"></a>00126         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> headerSize;
-<a name="l00127"></a>00127         <span class="keywordtype">string</span> headerBuffer;
-<a name="l00128"></a>00128         HeaderMap headers;
-<a name="l00129"></a>00129         
-<a name="l00130"></a>00130         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isDigit(<span class="keywordtype">char</span> byte) {
-<a name="l00131"></a>00131                 <span class="keywordflow">return</span> byte &gt;= <span class="charliteral">'0'</span> &amp;&amp; byte &lt;= <span class="charliteral">'9'</span>;
-<a name="l00132"></a>00132         }
-<a name="l00133"></a>00133         <span class="comment"></span>
-<a name="l00134"></a>00134 <span class="comment">        /**</span>
-<a name="l00135"></a>00135 <span class="comment">         * Parse the given header data into key-value pairs.</span>
-<a name="l00136"></a>00136 <span class="comment">         */</span>
-<a name="l00137"></a>00137         <span class="keywordtype">bool</span> parseHeaderData(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;data, HeaderMap &amp;output) {
-<a name="l00138"></a>00138                 <span class="keywordtype">bool</span> isName = <span class="keyword">true</span>; <span class="comment">// Whether we're currently expecting a name or a value.</span>
-<a name="l00139"></a>00139                 <span class="keyword">const</span> <span class="keywordtype">char</span> *startOfString, *current, *end;
-<a name="l00140"></a>00140                 StaticString key, value;
-<a name="l00141"></a>00141                 
-<a name="l00142"></a>00142                 <span class="keywordflow">if</span> (data.size() == 0) {
-<a name="l00143"></a>00143                         <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00144"></a>00144                 }
-<a name="l00145"></a>00145                 
-<a name="l00146"></a>00146                 startOfString = data.c_str();
-<a name="l00147"></a>00147                 end           = data.c_str() + data.size();
-<a name="l00148"></a>00148                 
-<a name="l00149"></a>00149                 <span class="keywordflow">if</span> (*(end - 1) != <span class="charliteral">'\0'</span>) {
-<a name="l00150"></a>00150                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00151"></a>00151                 }
-<a name="l00152"></a>00152                 
-<a name="l00153"></a>00153                 <span class="keywordflow">for</span> (current = data.c_str(); current != end; current++) {
-<a name="l00154"></a>00154                         <span class="keywordflow">if</span> (isName &amp;&amp; *current == <span class="charliteral">'\0'</span>) {
-<a name="l00155"></a>00155                                 key = StaticString(startOfString, current - startOfString);
-<a name="l00156"></a>00156                                 startOfString = current + 1;
-<a name="l00157"></a>00157                                 isName = <span class="keyword">false</span>;
-<a name="l00158"></a>00158                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!isName &amp;&amp; *current == <span class="charliteral">'\0'</span>) {
-<a name="l00159"></a>00159                                 value = StaticString(startOfString, current - startOfString);
-<a name="l00160"></a>00160                                 startOfString = current + 1;
-<a name="l00161"></a>00161                                 isName = <span class="keyword">true</span>;
-<a name="l00162"></a>00162                                 
-<a name="l00163"></a>00163                                 output[key] = value;
-<a name="l00164"></a>00164                                 key   = StaticString();
-<a name="l00165"></a>00165                                 value = StaticString();
-<a name="l00166"></a>00166                         }
-<a name="l00167"></a>00167                 }
-<a name="l00168"></a>00168                 
-<a name="l00169"></a>00169                 <span class="keywordflow">return</span> isName;
-<a name="l00170"></a>00170         }
-<a name="l00171"></a>00171         <span class="comment"></span>
-<a name="l00172"></a>00172 <span class="comment">        /**</span>
-<a name="l00173"></a>00173 <span class="comment">         * Process the given data, which contains header data and possibly</span>
-<a name="l00174"></a>00174 <span class="comment">         * some body data as well.</span>
-<a name="l00175"></a>00175 <span class="comment">         */</span>
-<a name="l00176"></a>00176         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> readHeaderData(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
-<a name="l00177"></a>00177                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bytesToRead;
-<a name="l00178"></a>00178                 
-<a name="l00179"></a>00179                 <span class="comment">// Calculate how many bytes of header data is left to be read.</span>
-<a name="l00180"></a>00180                 <span class="comment">// Do not read past the header data.</span>
-<a name="l00181"></a>00181                 <span class="keywordflow">if</span> (size &lt; headerSize - headerBuffer.size()) {
-<a name="l00182"></a>00182                         bytesToRead = size;
-<a name="l00183"></a>00183                 } <span class="keywordflow">else</span> {
-<a name="l00184"></a>00184                         bytesToRead = headerSize - headerBuffer.size();
-<a name="l00185"></a>00185                 }
-<a name="l00186"></a>00186                 <span class="comment">// Append the newly received header data to the header data buffer.</span>
-<a name="l00187"></a>00187                 headerBuffer.append(data, bytesToRead);
-<a name="l00188"></a>00188                 
-<a name="l00189"></a>00189                 <span class="keywordflow">if</span> (headerBuffer.size() == headerSize) {
-<a name="l00190"></a>00190                         <span class="comment">// We've received all header data. Now attempt to parse this.</span>
-<a name="l00191"></a>00191                         <span class="keywordflow">if</span> (bytesToRead &lt; size) {
-<a name="l00192"></a>00192                                 <span class="keywordflow">if</span> (data[bytesToRead] == <span class="charliteral">','</span>) {
-<a name="l00193"></a>00193                                         <span class="keywordflow">if</span> (parseHeaderData(headerBuffer, headers)) {
-<a name="l00194"></a>00194                                                 state = DONE;
-<a name="l00195"></a>00195                                                 <span class="keywordflow">return</span> bytesToRead + 1;
-<a name="l00196"></a>00196                                         } <span class="keywordflow">else</span> {
-<a name="l00197"></a>00197                                                 state = ERROR;
-<a name="l00198"></a>00198                                                 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>;
-<a name="l00199"></a>00199                                                 <span class="keywordflow">return</span> bytesToRead;
-<a name="l00200"></a>00200                                         }
-<a name="l00201"></a>00201                                 } <span class="keywordflow">else</span> {
-<a name="l00202"></a>00202                                         state = ERROR;
-<a name="l00203"></a>00203                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&amp;quot;,&amp;quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>;
-<a name="l00204"></a>00204                                         <span class="keywordflow">return</span> bytesToRead;
-<a name="l00205"></a>00205                                 }
-<a name="l00206"></a>00206                         } <span class="keywordflow">else</span> {
-<a name="l00207"></a>00207                                 <span class="keywordflow">if</span> (parseHeaderData(headerBuffer, headers)) {
-<a name="l00208"></a>00208                                         state = EXPECTING_COMMA;
-<a name="l00209"></a>00209                                 } <span class="keywordflow">else</span> {
-<a name="l00210"></a>00210                                         state = ERROR;
-<a name="l00211"></a>00211                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>;
-<a name="l00212"></a>00212                                 }
-<a name="l00213"></a>00213                                 <span class="keywordflow">return</span> bytesToRead;
-<a name="l00214"></a>00214                         }
-<a name="l00215"></a>00215                 } <span class="keywordflow">else</span> {
-<a name="l00216"></a>00216                         <span class="comment">// Not all header data has been received yet.</span>
-<a name="l00217"></a>00217                         <span class="keywordflow">return</span> bytesToRead;
-<a name="l00218"></a>00218                 }
-<a name="l00219"></a>00219         }
-<a name="l00220"></a>00220         
-<a name="l00221"></a>00221 <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00222"></a>00222 <span class="comment">        /**</span>
-<a name="l00223"></a>00223 <span class="comment">         * Create a new ScgiRequestParser, ready to parse a request.</span>
-<a name="l00224"></a>00224 <span class="comment">         *</span>
-<a name="l00225"></a>00225 <span class="comment">         * @param maxSize The maximum size that the SCGI data is allowed to</span>
-<a name="l00226"></a>00226 <span class="comment">         *                be, or 0 if no limit is desired.</span>
-<a name="l00227"></a>00227 <span class="comment">         */</span>
-<a name="l00228"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#1108e7ce9162289db8a5b14479325e7a">00228</a>         <a class="code" href="classPassenger_1_1ScgiRequestParser.html#1108e7ce9162289db8a5b14479325e7a" title="Create a new ScgiRequestParser, ready to parse a request.">ScgiRequestParser</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxSize = 0) {
-<a name="l00229"></a>00229                 this-&gt;maxSize = maxSize;
-<a name="l00230"></a>00230                 state = READING_LENGTH_STRING;
-<a name="l00231"></a>00231                 errorReason = NONE;
-<a name="l00232"></a>00232                 lengthStringBufferSize = 0;
-<a name="l00233"></a>00233                 headerSize = 0;
-<a name="l00234"></a>00234                 headers.set_empty_key(<span class="stringliteral">""</span>);
-<a name="l00235"></a>00235         }
-<a name="l00236"></a>00236         <span class="comment"></span>
-<a name="l00237"></a>00237 <span class="comment">        /**</span>
-<a name="l00238"></a>00238 <span class="comment">         * Feed SCGI request data to the parser.</span>
-<a name="l00239"></a>00239 <span class="comment">         *</span>
-<a name="l00240"></a>00240 <span class="comment">         * @param data The data to feed.</span>
-<a name="l00241"></a>00241 <span class="comment">         * @param size The size of the data, in bytes.</span>
-<a name="l00242"></a>00242 <span class="comment">         * @return The number of recognized SCGI header bytes. If this value</span>
-<a name="l00243"></a>00243 <span class="comment">         *         equals 'size', then it means all data in 'data' is part of</span>
-<a name="l00244"></a>00244 <span class="comment">         *         the SCGI header. If this value is less than size, then it</span>
-<a name="l00245"></a>00245 <span class="comment">         *         means only some data in 'data' is part of the SCGI header,</span>
-<a name="l00246"></a>00246 <span class="comment">         *         and the remaining 'size - result' bytes are part of the</span>
-<a name="l00247"></a>00247 <span class="comment">         *         request body.</span>
-<a name="l00248"></a>00248 <span class="comment">         * @pre size &gt; 0</span>
-<a name="l00249"></a>00249 <span class="comment">         * @post result &lt;= size</span>
-<a name="l00250"></a>00250 <span class="comment">         * @post if result &lt;= size: getState() == DONE || getState() == ERROR</span>
-<a name="l00251"></a>00251 <span class="comment">         */</span>
-<a name="l00252"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#0498c9529029969d5a77e1f74f95baa3">00252</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#0498c9529029969d5a77e1f74f95baa3" title="Feed SCGI request data to the parser.">feed</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
-<a name="l00253"></a>00253                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
-<a name="l00254"></a>00254                 
-<a name="l00255"></a>00255                 <span class="keywordflow">switch</span> (state) {
-<a name="l00256"></a>00256                 <span class="keywordflow">case</span> READING_LENGTH_STRING:
-<a name="l00257"></a>00257                         <span class="comment">// Keep processing length string data...</span>
-<a name="l00258"></a>00258                         <span class="keywordflow">for</span> (i = 0; i &lt; size; i++) {
-<a name="l00259"></a>00259                                 <span class="keywordtype">char</span> byte = data[i];
-<a name="l00260"></a>00260                                 
-<a name="l00261"></a>00261                                 <span class="keywordflow">if</span> (lengthStringBufferSize == <span class="keyword">sizeof</span>(lengthStringBuffer) - 1) {
-<a name="l00262"></a>00262                                         <span class="comment">// ...and abort if the length string is too long.</span>
-<a name="l00263"></a>00263                                         state = ERROR;
-<a name="l00264"></a>00264                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b" title="The length string is too large.">LENGTH_STRING_TOO_LARGE</a>;
-<a name="l00265"></a>00265                                         <span class="keywordflow">return</span> i;
-<a name="l00266"></a>00266                                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!isDigit(byte)) {
-<a name="l00267"></a>00267                                         <span class="keywordflow">if</span> (byte == <span class="charliteral">':'</span>) {
-<a name="l00268"></a>00268                                                 <span class="comment">// ...until the end of the length string has been reached.</span>
-<a name="l00269"></a>00269                                                 state = READING_HEADER_DATA;
-<a name="l00270"></a>00270                                                 lengthStringBuffer[lengthStringBufferSize] = <span class="charliteral">'\0'</span>;
-<a name="l00271"></a>00271                                                 headerSize = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(lengthStringBuffer);
-<a name="l00272"></a>00272                                                 <span class="keywordflow">if</span> (maxSize &gt; 0 &amp;&amp; headerSize &gt; maxSize) {
-<a name="l00273"></a>00273                                                         state = ERROR;
-<a name="l00274"></a>00274                                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d" title="The header is larger than the maxSize value provided to the constructor.">LIMIT_REACHED</a>;
-<a name="l00275"></a>00275                                                 } <span class="keywordflow">else</span> {
-<a name="l00276"></a>00276                                                         headerBuffer.reserve(headerSize);
-<a name="l00277"></a>00277                                                         <span class="comment">// From here on, process the rest of the data that we've</span>
-<a name="l00278"></a>00278                                                         <span class="comment">// received, as header data.</span>
-<a name="l00279"></a>00279                                                         <span class="keywordflow">return</span> readHeaderData(data + i + 1, size - i - 1) + i + 1;
-<a name="l00280"></a>00280                                                 }
-<a name="l00281"></a>00281                                         } <span class="keywordflow">else</span> {
-<a name="l00282"></a>00282                                                 <span class="comment">// ...until we encounter a parse error.</span>
-<a name="l00283"></a>00283                                                 state = ERROR;
-<a name="l00284"></a>00284                                                 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332" title="The length string contains an invalid character.">INVALID_LENGTH_STRING</a>;
-<a name="l00285"></a>00285                                                 <span class="keywordflow">return</span> i;
-<a name="l00286"></a>00286                                         }
-<a name="l00287"></a>00287                                 } <span class="keywordflow">else</span> {
-<a name="l00288"></a>00288                                         lengthStringBuffer[lengthStringBufferSize] = byte;
-<a name="l00289"></a>00289                                         lengthStringBufferSize++;
-<a name="l00290"></a>00290                                 }
-<a name="l00291"></a>00291                         }
-<a name="l00292"></a>00292                         <span class="keywordflow">return</span> i;
-<a name="l00293"></a>00293                 
-<a name="l00294"></a>00294                 <span class="keywordflow">case</span> READING_HEADER_DATA:
-<a name="l00295"></a>00295                         <span class="keywordflow">return</span> readHeaderData(data, size);
-<a name="l00296"></a>00296                 
-<a name="l00297"></a>00297                 <span class="keywordflow">case</span> EXPECTING_COMMA:
-<a name="l00298"></a>00298                         <span class="keywordflow">if</span> (data[0] == <span class="charliteral">','</span>) {
-<a name="l00299"></a>00299                                 state = DONE;
-<a name="l00300"></a>00300                                 <span class="keywordflow">return</span> 1;
-<a name="l00301"></a>00301                         } <span class="keywordflow">else</span> {
-<a name="l00302"></a>00302                                 state = ERROR;
-<a name="l00303"></a>00303                                 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&amp;quot;,&amp;quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>;
-<a name="l00304"></a>00304                                 <span class="keywordflow">return</span> 0;
-<a name="l00305"></a>00305                         }
-<a name="l00306"></a>00306                 
-<a name="l00307"></a>00307                 <span class="keywordflow">default</span>:
-<a name="l00308"></a>00308                         <span class="keywordflow">return</span> 0;
-<a name="l00309"></a>00309                 }
-<a name="l00310"></a>00310         }
-<a name="l00311"></a>00311         <span class="comment"></span>
-<a name="l00312"></a>00312 <span class="comment">        /**</span>
-<a name="l00313"></a>00313 <span class="comment">         * Get the raw header data that has been processed so far.</span>
-<a name="l00314"></a>00314 <span class="comment">         */</span>
-<a name="l00315"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#a96dbb7c4c642ac74f30ed5b14a64e86">00315</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#a96dbb7c4c642ac74f30ed5b14a64e86" title="Get the raw header data that has been processed so far.">getHeaderData</a>()<span class="keyword"> const </span>{
-<a name="l00316"></a>00316                 <span class="keywordflow">return</span> headerBuffer;
-<a name="l00317"></a>00317         }
-<a name="l00318"></a>00318         <span class="comment"></span>
-<a name="l00319"></a>00319 <span class="comment">        /**</span>
-<a name="l00320"></a>00320 <span class="comment">         * Get the value of the header with the given name.</span>
-<a name="l00321"></a>00321 <span class="comment">         * Lookup is case-sensitive.</span>
-<a name="l00322"></a>00322 <span class="comment">         *</span>
-<a name="l00323"></a>00323 <span class="comment">         * Returns the empty string if there is no such header.</span>
-<a name="l00324"></a>00324 <span class="comment">         *</span>
-<a name="l00325"></a>00325 <span class="comment">         * @pre getState() == DONE</span>
-<a name="l00326"></a>00326 <span class="comment">         */</span>
-<a name="l00327"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#82321480ad2f8ac7ba58ff865131f6b4">00327</a>         <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#82321480ad2f8ac7ba58ff865131f6b4" title="Get the value of the header with the given name.">getHeader</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &amp;name)<span class="keyword"> const </span>{
-<a name="l00328"></a>00328                 HeaderMap::const_iterator it(headers.find(name));
-<a name="l00329"></a>00329                 <span class="keywordflow">if</span> (it == headers.end()) {
-<a name="l00330"></a>00330                         <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-<a name="l00331"></a>00331                 } <span class="keywordflow">else</span> {
-<a name="l00332"></a>00332                         <span class="keywordflow">return</span> it-&gt;second;
-<a name="l00333"></a>00333                 }
-<a name="l00334"></a>00334         }
-<a name="l00335"></a>00335         <span class="comment"></span>
-<a name="l00336"></a>00336 <span class="comment">        /**</span>
-<a name="l00337"></a>00337 <span class="comment">         * Checks whether there is a header with the given name.</span>
-<a name="l00338"></a>00338 <span class="comment">         * Lookup is case-sensitive.</span>
-<a name="l00339"></a>00339 <span class="comment">         *</span>
-<a name="l00340"></a>00340 <span class="comment">         * @pre getState() == DONE</span>
-<a name="l00341"></a>00341 <span class="comment">         */</span>
-<a name="l00342"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#d82e358a0ad051ab2bdd2374e9ab4ff8">00342</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#d82e358a0ad051ab2bdd2374e9ab4ff8" title="Checks whether there is a header with the given name.">hasHeader</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &amp;name)<span class="keyword"> const </span>{
-<a name="l00343"></a>00343                 <span class="keywordflow">return</span> headers.find(name) != headers.end();
-<a name="l00344"></a>00344         }
-<a name="l00345"></a>00345         <span class="comment"></span>
-<a name="l00346"></a>00346 <span class="comment">        /**</span>
-<a name="l00347"></a>00347 <span class="comment">         * Get the parser's current state.</span>
-<a name="l00348"></a>00348 <span class="comment">         */</span>
-<a name="l00349"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#5bd7dbce81c69ae9e3462e84daf09012">00349</a>         State <a class="code" href="classPassenger_1_1ScgiRequestParser.html#5bd7dbce81c69ae9e3462e84daf09012" title="Get the parser&amp;#39;s current state.">getState</a>()<span class="keyword"> const </span>{
-<a name="l00350"></a>00350                 <span class="keywordflow">return</span> state;
-<a name="l00351"></a>00351         }
-<a name="l00352"></a>00352         <span class="comment"></span>
-<a name="l00353"></a>00353 <span class="comment">        /**</span>
-<a name="l00354"></a>00354 <span class="comment">         * Returns the reason why the parser entered the error state.</span>
-<a name="l00355"></a>00355 <span class="comment">         *</span>
-<a name="l00356"></a>00356 <span class="comment">         * @pre getState() == ERROR</span>
-<a name="l00357"></a>00357 <span class="comment">         */</span>
-<a name="l00358"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#4114253f47d3e7e5c0dddc3cd11c5596">00358</a>         <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#4114253f47d3e7e5c0dddc3cd11c5596" title="Returns the reason why the parser entered the error state.">getErrorReason</a>()<span class="keyword"> const </span>{
-<a name="l00359"></a>00359                 <span class="keywordflow">return</span> errorReason;
-<a name="l00360"></a>00360         }
-<a name="l00361"></a>00361         <span class="comment"></span>
-<a name="l00362"></a>00362 <span class="comment">        /**</span>
-<a name="l00363"></a>00363 <span class="comment">         * Checks whether this parser is still capable of accepting input (that</span>
-<a name="l00364"></a>00364 <span class="comment">         * is, that this parser is not in a final state).</span>
-<a name="l00365"></a>00365 <span class="comment">         */</span>
-<a name="l00366"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#5368ed40bf7c896f68d7ffaae164a092">00366</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#5368ed40bf7c896f68d7ffaae164a092" title="Checks whether this parser is still capable of accepting input (that is, that this...">acceptingInput</a>()<span class="keyword"> const </span>{
-<a name="l00367"></a>00367                 <span class="keywordflow">return</span> state != DONE &amp;&amp; state != ERROR;
-<a name="l00368"></a>00368         }
-<a name="l00369"></a>00369 };
-<a name="l00370"></a>00370 
-<a name="l00371"></a>00371 } <span class="comment">// namespace Passenger</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;cstdlib&gt;</span>
+<a name="l00031"></a>00031 
+<a name="l00032"></a>00032 <span class="preprocessor">#include "StaticString.h"</span>
+<a name="l00033"></a>00033 
+<a name="l00034"></a>00034 <span class="keyword">namespace </span>Passenger {
+<a name="l00035"></a>00035 
+<a name="l00036"></a>00036 <span class="keyword">using namespace </span>std;
+<a name="l00037"></a>00037 <span class="keyword">using namespace </span>google;
+<a name="l00038"></a>00038 <span class="comment"></span>
+<a name="l00039"></a>00039 <span class="comment">/**</span>
+<a name="l00040"></a>00040 <span class="comment"> * A parser for SCGI requests. It parses the request header and ignores the</span>
+<a name="l00041"></a>00041 <span class="comment"> * body data.</span>
+<a name="l00042"></a>00042 <span class="comment"> *</span>
+<a name="l00043"></a>00043 <span class="comment"> * You can use it by constructing a parser object, then feeding data to the</span>
+<a name="l00044"></a>00044 <span class="comment"> * parser until it has reached a final state.</span>
+<a name="l00045"></a>00045 <span class="comment"> *</span>
+<a name="l00046"></a>00046 <span class="comment"> * Example:</span>
+<a name="l00047"></a>00047 <span class="comment"> * @code</span>
+<a name="l00048"></a>00048 <span class="comment"> *    ScgiRequestParser parser;</span>
+<a name="l00049"></a>00049 <span class="comment"> *    char buf[1024 * 16];</span>
+<a name="l00050"></a>00050 <span class="comment"> *    ssize_t size;</span>
+<a name="l00051"></a>00051 <span class="comment"> *    unsigned in bytesAccepted;</span>
+<a name="l00052"></a>00052 <span class="comment"> *    </span>
+<a name="l00053"></a>00053 <span class="comment"> *    do {</span>
+<a name="l00054"></a>00054 <span class="comment"> *        size = read(fd, buf, sizeof(buf));</span>
+<a name="l00055"></a>00055 <span class="comment"> *        bytesAccepted = parser.feed(buf, size);</span>
+<a name="l00056"></a>00056 <span class="comment"> *    } while (parser.acceptingInput());</span>
+<a name="l00057"></a>00057 <span class="comment"> *    // Parser is done when its return value isn't equal to the input size.</span>
+<a name="l00058"></a>00058 <span class="comment"> *    </span>
+<a name="l00059"></a>00059 <span class="comment"> *    // Check whether a parse error occured.</span>
+<a name="l00060"></a>00060 <span class="comment"> *    if (parser.getState() == ScgiRequestParser::ERROR) {</span>
+<a name="l00061"></a>00061 <span class="comment"> *        bailOut();</span>
+<a name="l00062"></a>00062 <span class="comment"> *    } else {</span>
+<a name="l00063"></a>00063 <span class="comment"> *        // All good! Do something with the SCGI header that the parser parsed.</span>
+<a name="l00064"></a>00064 <span class="comment"> *        processHeader(parser.getHeaderData());</span>
+<a name="l00065"></a>00065 <span class="comment"> *        </span>
+<a name="l00066"></a>00066 <span class="comment"> *        // If the last buffer passed to the parser also contains body data,</span>
+<a name="l00067"></a>00067 <span class="comment"> *        // then the body data starts at 'buf + bytesAccepted'.</span>
+<a name="l00068"></a>00068 <span class="comment"> *        if (bytesAccepted &lt; size) {</span>
+<a name="l00069"></a>00069 <span class="comment"> *            processBody(buf + bytesAccepted);</span>
+<a name="l00070"></a>00070 <span class="comment"> *        }</span>
+<a name="l00071"></a>00071 <span class="comment"> *        while (!end_of_file(fd)) {</span>
+<a name="l00072"></a>00072 <span class="comment"> *            ... read(...) ...</span>
+<a name="l00073"></a>00073 <span class="comment"> *            processBody(...);</span>
+<a name="l00074"></a>00074 <span class="comment"> *        }</span>
+<a name="l00075"></a>00075 <span class="comment"> *    }</span>
+<a name="l00076"></a>00076 <span class="comment"> * @endcode</span>
+<a name="l00077"></a>00077 <span class="comment"> *</span>
+<a name="l00078"></a>00078 <span class="comment"> * Parser properties:</span>
+<a name="l00079"></a>00079 <span class="comment"> * - A parser object can only process a single SCGI request. You must discard</span>
+<a name="l00080"></a>00080 <span class="comment"> *   the existing parser object and create a new one if you want to process</span>
+<a name="l00081"></a>00081 <span class="comment"> *   another SCGI request.</span>
+<a name="l00082"></a>00082 <span class="comment"> * - This parser checks whether the header netstring is valid. It will enter</span>
+<a name="l00083"></a>00083 <span class="comment"> *   the error state if it encounters a parse error.</span>
+<a name="l00084"></a>00084 <span class="comment"> * - However, this parser does not perform any validation of the actual header</span>
+<a name="l00085"></a>00085 <span class="comment"> *   contents. For example, it doesn't check that CONTENT_LENGTH is the first</span>
+<a name="l00086"></a>00086 <span class="comment"> *   header, or that the SCGI header is present.</span>
+<a name="l00087"></a>00087 <span class="comment"> */</span>
+<a name="l00088"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html">00088</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ScgiRequestParser.html" title="A parser for SCGI requests.">ScgiRequestParser</a> {
+<a name="l00089"></a>00089 <span class="keyword">public</span>:
+<a name="l00090"></a>00090         <span class="keyword">enum</span> State {
+<a name="l00091"></a>00091                 READING_LENGTH_STRING,
+<a name="l00092"></a>00092                 READING_HEADER_DATA,
+<a name="l00093"></a>00093                 EXPECTING_COMMA,
+<a name="l00094"></a>00094                 DONE,
+<a name="l00095"></a>00095                 ERROR
+<a name="l00096"></a>00096         };
+<a name="l00097"></a>00097         
+<a name="l00098"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">00098</a>         <span class="keyword">enum</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> {
+<a name="l00099"></a>00099                 NONE,
+<a name="l00100"></a>00100                 <span class="comment"></span>
+<a name="l00101"></a>00101 <span class="comment">                /** The length string is too large. */</span>
+<a name="l00102"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b">00102</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b" title="The length string is too large.">LENGTH_STRING_TOO_LARGE</a>,
+<a name="l00103"></a>00103                 <span class="comment"></span>
+<a name="l00104"></a>00104 <span class="comment">                /** The header is larger than the maxSize value provided to the constructor. */</span>
+<a name="l00105"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d">00105</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d" title="The header is larger than the maxSize value provided to the constructor.">LIMIT_REACHED</a>,
+<a name="l00106"></a>00106                 <span class="comment"></span>
+<a name="l00107"></a>00107 <span class="comment">                /** The length string contains an invalid character. */</span>
+<a name="l00108"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332">00108</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332" title="The length string contains an invalid character.">INVALID_LENGTH_STRING</a>,
+<a name="l00109"></a>00109                 <span class="comment"></span>
+<a name="l00110"></a>00110 <span class="comment">                /** A header terminator character (",") was expected, but some else</span>
+<a name="l00111"></a>00111 <span class="comment">                 * was encountered instead. */</span>
+<a name="l00112"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44">00112</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&amp;quot;,&amp;quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>,
+<a name="l00113"></a>00113                 <span class="comment"></span>
+<a name="l00114"></a>00114 <span class="comment">                /** The header data itself contains errors. */</span>
+<a name="l00115"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add">00115</a>                 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>
+<a name="l00116"></a>00116         };
+<a name="l00117"></a>00117         
+<a name="l00118"></a>00118 <span class="keyword">private</span>:
+<a name="l00119"></a>00119         <span class="keyword">typedef</span> dense_hash_map&lt;StaticString, StaticString, StaticString::Hash&gt; HeaderMap;
+<a name="l00120"></a>00120         
+<a name="l00121"></a>00121         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxSize;
+<a name="l00122"></a>00122         
+<a name="l00123"></a>00123         State state;
+<a name="l00124"></a>00124         <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> errorReason;
+<a name="l00125"></a>00125         <span class="keywordtype">char</span> lengthStringBuffer[<span class="keyword">sizeof</span>(<span class="stringliteral">"4294967296"</span>)];
+<a name="l00126"></a>00126         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lengthStringBufferSize;
+<a name="l00127"></a>00127         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> headerSize;
+<a name="l00128"></a>00128         <span class="keywordtype">string</span> headerBuffer;
+<a name="l00129"></a>00129         HeaderMap headers;
+<a name="l00130"></a>00130         
+<a name="l00131"></a>00131         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isDigit(<span class="keywordtype">char</span> byte) {
+<a name="l00132"></a>00132                 <span class="keywordflow">return</span> byte &gt;= <span class="charliteral">'0'</span> &amp;&amp; byte &lt;= <span class="charliteral">'9'</span>;
+<a name="l00133"></a>00133         }
+<a name="l00134"></a>00134         <span class="comment"></span>
+<a name="l00135"></a>00135 <span class="comment">        /**</span>
+<a name="l00136"></a>00136 <span class="comment">         * Parse the given header data into key-value pairs.</span>
+<a name="l00137"></a>00137 <span class="comment">         */</span>
+<a name="l00138"></a>00138         <span class="keywordtype">bool</span> parseHeaderData(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;data, HeaderMap &amp;output) {
+<a name="l00139"></a>00139                 <span class="keywordtype">bool</span> isName = <span class="keyword">true</span>; <span class="comment">// Whether we're currently expecting a name or a value.</span>
+<a name="l00140"></a>00140                 <span class="keyword">const</span> <span class="keywordtype">char</span> *startOfString, *current, *end;
+<a name="l00141"></a>00141                 StaticString key, value;
+<a name="l00142"></a>00142                 
+<a name="l00143"></a>00143                 <span class="keywordflow">if</span> (data.size() == 0) {
+<a name="l00144"></a>00144                         <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00145"></a>00145                 }
+<a name="l00146"></a>00146                 
+<a name="l00147"></a>00147                 startOfString = data.c_str();
+<a name="l00148"></a>00148                 end           = data.c_str() + data.size();
+<a name="l00149"></a>00149                 
+<a name="l00150"></a>00150                 <span class="keywordflow">if</span> (*(end - 1) != <span class="charliteral">'\0'</span>) {
+<a name="l00151"></a>00151                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00152"></a>00152                 }
+<a name="l00153"></a>00153                 
+<a name="l00154"></a>00154                 <span class="keywordflow">for</span> (current = data.c_str(); current != end; current++) {
+<a name="l00155"></a>00155                         <span class="keywordflow">if</span> (isName &amp;&amp; *current == <span class="charliteral">'\0'</span>) {
+<a name="l00156"></a>00156                                 key = StaticString(startOfString, current - startOfString);
+<a name="l00157"></a>00157                                 startOfString = current + 1;
+<a name="l00158"></a>00158                                 isName = <span class="keyword">false</span>;
+<a name="l00159"></a>00159                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!isName &amp;&amp; *current == <span class="charliteral">'\0'</span>) {
+<a name="l00160"></a>00160                                 value = StaticString(startOfString, current - startOfString);
+<a name="l00161"></a>00161                                 startOfString = current + 1;
+<a name="l00162"></a>00162                                 isName = <span class="keyword">true</span>;
+<a name="l00163"></a>00163                                 
+<a name="l00164"></a>00164                                 output[key] = value;
+<a name="l00165"></a>00165                                 key   = StaticString();
+<a name="l00166"></a>00166                                 value = StaticString();
+<a name="l00167"></a>00167                         }
+<a name="l00168"></a>00168                 }
+<a name="l00169"></a>00169                 
+<a name="l00170"></a>00170                 <span class="keywordflow">return</span> isName;
+<a name="l00171"></a>00171         }
+<a name="l00172"></a>00172         <span class="comment"></span>
+<a name="l00173"></a>00173 <span class="comment">        /**</span>
+<a name="l00174"></a>00174 <span class="comment">         * Process the given data, which contains header data and possibly</span>
+<a name="l00175"></a>00175 <span class="comment">         * some body data as well.</span>
+<a name="l00176"></a>00176 <span class="comment">         */</span>
+<a name="l00177"></a>00177         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> readHeaderData(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00178"></a>00178                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bytesToRead;
+<a name="l00179"></a>00179                 
+<a name="l00180"></a>00180                 <span class="comment">// Calculate how many bytes of header data is left to be read.</span>
+<a name="l00181"></a>00181                 <span class="comment">// Do not read past the header data.</span>
+<a name="l00182"></a>00182                 <span class="keywordflow">if</span> (size &lt; headerSize - headerBuffer.size()) {
+<a name="l00183"></a>00183                         bytesToRead = size;
+<a name="l00184"></a>00184                 } <span class="keywordflow">else</span> {
+<a name="l00185"></a>00185                         bytesToRead = headerSize - headerBuffer.size();
+<a name="l00186"></a>00186                 }
+<a name="l00187"></a>00187                 <span class="comment">// Append the newly received header data to the header data buffer.</span>
+<a name="l00188"></a>00188                 headerBuffer.append(data, bytesToRead);
+<a name="l00189"></a>00189                 
+<a name="l00190"></a>00190                 <span class="keywordflow">if</span> (headerBuffer.size() == headerSize) {
+<a name="l00191"></a>00191                         <span class="comment">// We've received all header data. Now attempt to parse this.</span>
+<a name="l00192"></a>00192                         <span class="keywordflow">if</span> (bytesToRead &lt; size) {
+<a name="l00193"></a>00193                                 <span class="keywordflow">if</span> (data[bytesToRead] == <span class="charliteral">','</span>) {
+<a name="l00194"></a>00194                                         <span class="keywordflow">if</span> (parseHeaderData(headerBuffer, headers)) {
+<a name="l00195"></a>00195                                                 state = DONE;
+<a name="l00196"></a>00196                                                 <span class="keywordflow">return</span> bytesToRead + 1;
+<a name="l00197"></a>00197                                         } <span class="keywordflow">else</span> {
+<a name="l00198"></a>00198                                                 state = ERROR;
+<a name="l00199"></a>00199                                                 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>;
+<a name="l00200"></a>00200                                                 <span class="keywordflow">return</span> bytesToRead;
+<a name="l00201"></a>00201                                         }
+<a name="l00202"></a>00202                                 } <span class="keywordflow">else</span> {
+<a name="l00203"></a>00203                                         state = ERROR;
+<a name="l00204"></a>00204                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&amp;quot;,&amp;quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>;
+<a name="l00205"></a>00205                                         <span class="keywordflow">return</span> bytesToRead;
+<a name="l00206"></a>00206                                 }
+<a name="l00207"></a>00207                         } <span class="keywordflow">else</span> {
+<a name="l00208"></a>00208                                 <span class="keywordflow">if</span> (parseHeaderData(headerBuffer, headers)) {
+<a name="l00209"></a>00209                                         state = EXPECTING_COMMA;
+<a name="l00210"></a>00210                                 } <span class="keywordflow">else</span> {
+<a name="l00211"></a>00211                                         state = ERROR;
+<a name="l00212"></a>00212                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>;
+<a name="l00213"></a>00213                                 }
+<a name="l00214"></a>00214                                 <span class="keywordflow">return</span> bytesToRead;
+<a name="l00215"></a>00215                         }
+<a name="l00216"></a>00216                 } <span class="keywordflow">else</span> {
+<a name="l00217"></a>00217                         <span class="comment">// Not all header data has been received yet.</span>
+<a name="l00218"></a>00218                         <span class="keywordflow">return</span> bytesToRead;
+<a name="l00219"></a>00219                 }
+<a name="l00220"></a>00220         }
+<a name="l00221"></a>00221         
+<a name="l00222"></a>00222 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00223"></a>00223 <span class="comment">        /**</span>
+<a name="l00224"></a>00224 <span class="comment">         * Create a new ScgiRequestParser, ready to parse a request.</span>
+<a name="l00225"></a>00225 <span class="comment">         *</span>
+<a name="l00226"></a>00226 <span class="comment">         * @param maxSize The maximum size that the SCGI data is allowed to</span>
+<a name="l00227"></a>00227 <span class="comment">         *                be, or 0 if no limit is desired.</span>
+<a name="l00228"></a>00228 <span class="comment">         */</span>
+<a name="l00229"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#1108e7ce9162289db8a5b14479325e7a">00229</a>         <a class="code" href="classPassenger_1_1ScgiRequestParser.html#1108e7ce9162289db8a5b14479325e7a" title="Create a new ScgiRequestParser, ready to parse a request.">ScgiRequestParser</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxSize = 0) {
+<a name="l00230"></a>00230                 this-&gt;maxSize = maxSize;
+<a name="l00231"></a>00231                 state = READING_LENGTH_STRING;
+<a name="l00232"></a>00232                 errorReason = NONE;
+<a name="l00233"></a>00233                 lengthStringBufferSize = 0;
+<a name="l00234"></a>00234                 headerSize = 0;
+<a name="l00235"></a>00235                 headers.set_empty_key(<span class="stringliteral">""</span>);
+<a name="l00236"></a>00236         }
+<a name="l00237"></a>00237         <span class="comment"></span>
+<a name="l00238"></a>00238 <span class="comment">        /**</span>
+<a name="l00239"></a>00239 <span class="comment">         * Feed SCGI request data to the parser.</span>
+<a name="l00240"></a>00240 <span class="comment">         *</span>
+<a name="l00241"></a>00241 <span class="comment">         * @param data The data to feed.</span>
+<a name="l00242"></a>00242 <span class="comment">         * @param size The size of the data, in bytes.</span>
+<a name="l00243"></a>00243 <span class="comment">         * @return The number of recognized SCGI header bytes. If this value</span>
+<a name="l00244"></a>00244 <span class="comment">         *         equals 'size', then it means all data in 'data' is part of</span>
+<a name="l00245"></a>00245 <span class="comment">         *         the SCGI header. If this value is less than size, then it</span>
+<a name="l00246"></a>00246 <span class="comment">         *         means only some data in 'data' is part of the SCGI header,</span>
+<a name="l00247"></a>00247 <span class="comment">         *         and the remaining 'size - result' bytes are part of the</span>
+<a name="l00248"></a>00248 <span class="comment">         *         request body.</span>
+<a name="l00249"></a>00249 <span class="comment">         * @pre size &gt; 0</span>
+<a name="l00250"></a>00250 <span class="comment">         * @post result &lt;= size</span>
+<a name="l00251"></a>00251 <span class="comment">         * @post if result &lt;= size: getState() == DONE || getState() == ERROR</span>
+<a name="l00252"></a>00252 <span class="comment">         */</span>
+<a name="l00253"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#0498c9529029969d5a77e1f74f95baa3">00253</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#0498c9529029969d5a77e1f74f95baa3" title="Feed SCGI request data to the parser.">feed</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00254"></a>00254                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
+<a name="l00255"></a>00255                 
+<a name="l00256"></a>00256                 <span class="keywordflow">switch</span> (state) {
+<a name="l00257"></a>00257                 <span class="keywordflow">case</span> READING_LENGTH_STRING:
+<a name="l00258"></a>00258                         <span class="comment">// Keep processing length string data...</span>
+<a name="l00259"></a>00259                         <span class="keywordflow">for</span> (i = 0; i &lt; size; i++) {
+<a name="l00260"></a>00260                                 <span class="keywordtype">char</span> byte = data[i];
+<a name="l00261"></a>00261                                 
+<a name="l00262"></a>00262                                 <span class="keywordflow">if</span> (lengthStringBufferSize == <span class="keyword">sizeof</span>(lengthStringBuffer) - 1) {
+<a name="l00263"></a>00263                                         <span class="comment">// ...and abort if the length string is too long.</span>
+<a name="l00264"></a>00264                                         state = ERROR;
+<a name="l00265"></a>00265                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b" title="The length string is too large.">LENGTH_STRING_TOO_LARGE</a>;
+<a name="l00266"></a>00266                                         <span class="keywordflow">return</span> i;
+<a name="l00267"></a>00267                                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!isDigit(byte)) {
+<a name="l00268"></a>00268                                         <span class="keywordflow">if</span> (byte == <span class="charliteral">':'</span>) {
+<a name="l00269"></a>00269                                                 <span class="comment">// ...until the end of the length string has been reached.</span>
+<a name="l00270"></a>00270                                                 state = READING_HEADER_DATA;
+<a name="l00271"></a>00271                                                 lengthStringBuffer[lengthStringBufferSize] = <span class="charliteral">'\0'</span>;
+<a name="l00272"></a>00272                                                 headerSize = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(lengthStringBuffer);
+<a name="l00273"></a>00273                                                 <span class="keywordflow">if</span> (maxSize &gt; 0 &amp;&amp; headerSize &gt; maxSize) {
+<a name="l00274"></a>00274                                                         state = ERROR;
+<a name="l00275"></a>00275                                                         errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d" title="The header is larger than the maxSize value provided to the constructor.">LIMIT_REACHED</a>;
+<a name="l00276"></a>00276                                                 } <span class="keywordflow">else</span> {
+<a name="l00277"></a>00277                                                         headerBuffer.reserve(headerSize);
+<a name="l00278"></a>00278                                                         <span class="comment">// From here on, process the rest of the data that we've</span>
+<a name="l00279"></a>00279                                                         <span class="comment">// received, as header data.</span>
+<a name="l00280"></a>00280                                                         <span class="keywordflow">return</span> readHeaderData(data + i + 1, size - i - 1) + i + 1;
+<a name="l00281"></a>00281                                                 }
+<a name="l00282"></a>00282                                         } <span class="keywordflow">else</span> {
+<a name="l00283"></a>00283                                                 <span class="comment">// ...until we encounter a parse error.</span>
+<a name="l00284"></a>00284                                                 state = ERROR;
+<a name="l00285"></a>00285                                                 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332" title="The length string contains an invalid character.">INVALID_LENGTH_STRING</a>;
+<a name="l00286"></a>00286                                                 <span class="keywordflow">return</span> i;
+<a name="l00287"></a>00287                                         }
+<a name="l00288"></a>00288                                 } <span class="keywordflow">else</span> {
+<a name="l00289"></a>00289                                         lengthStringBuffer[lengthStringBufferSize] = byte;
+<a name="l00290"></a>00290                                         lengthStringBufferSize++;
+<a name="l00291"></a>00291                                 }
+<a name="l00292"></a>00292                         }
+<a name="l00293"></a>00293                         <span class="keywordflow">return</span> i;
+<a name="l00294"></a>00294                 
+<a name="l00295"></a>00295                 <span class="keywordflow">case</span> READING_HEADER_DATA:
+<a name="l00296"></a>00296                         <span class="keywordflow">return</span> readHeaderData(data, size);
+<a name="l00297"></a>00297                 
+<a name="l00298"></a>00298                 <span class="keywordflow">case</span> EXPECTING_COMMA:
+<a name="l00299"></a>00299                         <span class="keywordflow">if</span> (data[0] == <span class="charliteral">','</span>) {
+<a name="l00300"></a>00300                                 state = DONE;
+<a name="l00301"></a>00301                                 <span class="keywordflow">return</span> 1;
+<a name="l00302"></a>00302                         } <span class="keywordflow">else</span> {
+<a name="l00303"></a>00303                                 state = ERROR;
+<a name="l00304"></a>00304                                 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&amp;quot;,&amp;quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>;
+<a name="l00305"></a>00305                                 <span class="keywordflow">return</span> 0;
+<a name="l00306"></a>00306                         }
+<a name="l00307"></a>00307                 
+<a name="l00308"></a>00308                 <span class="keywordflow">default</span>:
+<a name="l00309"></a>00309                         <span class="keywordflow">return</span> 0;
+<a name="l00310"></a>00310                 }
+<a name="l00311"></a>00311         }
+<a name="l00312"></a>00312         <span class="comment"></span>
+<a name="l00313"></a>00313 <span class="comment">        /**</span>
+<a name="l00314"></a>00314 <span class="comment">         * Get the raw header data that has been processed so far.</span>
+<a name="l00315"></a>00315 <span class="comment">         */</span>
+<a name="l00316"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#a96dbb7c4c642ac74f30ed5b14a64e86">00316</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#a96dbb7c4c642ac74f30ed5b14a64e86" title="Get the raw header data that has been processed so far.">getHeaderData</a>()<span class="keyword"> const </span>{
+<a name="l00317"></a>00317                 <span class="keywordflow">return</span> headerBuffer;
+<a name="l00318"></a>00318         }
+<a name="l00319"></a>00319         <span class="comment"></span>
+<a name="l00320"></a>00320 <span class="comment">        /**</span>
+<a name="l00321"></a>00321 <span class="comment">         * Get the value of the header with the given name.</span>
+<a name="l00322"></a>00322 <span class="comment">         * Lookup is case-sensitive.</span>
+<a name="l00323"></a>00323 <span class="comment">         *</span>
+<a name="l00324"></a>00324 <span class="comment">         * Returns the empty string if there is no such header.</span>
+<a name="l00325"></a>00325 <span class="comment">         *</span>
+<a name="l00326"></a>00326 <span class="comment">         * @pre getState() == DONE</span>
+<a name="l00327"></a>00327 <span class="comment">         */</span>
+<a name="l00328"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#82321480ad2f8ac7ba58ff865131f6b4">00328</a>         <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#82321480ad2f8ac7ba58ff865131f6b4" title="Get the value of the header with the given name.">getHeader</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &amp;name)<span class="keyword"> const </span>{
+<a name="l00329"></a>00329                 HeaderMap::const_iterator it(headers.find(name));
+<a name="l00330"></a>00330                 <span class="keywordflow">if</span> (it == headers.end()) {
+<a name="l00331"></a>00331                         <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+<a name="l00332"></a>00332                 } <span class="keywordflow">else</span> {
+<a name="l00333"></a>00333                         <span class="keywordflow">return</span> it-&gt;second;
+<a name="l00334"></a>00334                 }
+<a name="l00335"></a>00335         }
+<a name="l00336"></a>00336         <span class="comment"></span>
+<a name="l00337"></a>00337 <span class="comment">        /**</span>
+<a name="l00338"></a>00338 <span class="comment">         * Checks whether there is a header with the given name.</span>
+<a name="l00339"></a>00339 <span class="comment">         * Lookup is case-sensitive.</span>
+<a name="l00340"></a>00340 <span class="comment">         *</span>
+<a name="l00341"></a>00341 <span class="comment">         * @pre getState() == DONE</span>
+<a name="l00342"></a>00342 <span class="comment">         */</span>
+<a name="l00343"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#d82e358a0ad051ab2bdd2374e9ab4ff8">00343</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#d82e358a0ad051ab2bdd2374e9ab4ff8" title="Checks whether there is a header with the given name.">hasHeader</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &amp;name)<span class="keyword"> const </span>{
+<a name="l00344"></a>00344                 <span class="keywordflow">return</span> headers.find(name) != headers.end();
+<a name="l00345"></a>00345         }
+<a name="l00346"></a>00346         <span class="comment"></span>
+<a name="l00347"></a>00347 <span class="comment">        /**</span>
+<a name="l00348"></a>00348 <span class="comment">         * Get the parser's current state.</span>
+<a name="l00349"></a>00349 <span class="comment">         */</span>
+<a name="l00350"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#5bd7dbce81c69ae9e3462e84daf09012">00350</a>         State <a class="code" href="classPassenger_1_1ScgiRequestParser.html#5bd7dbce81c69ae9e3462e84daf09012" title="Get the parser&amp;#39;s current state.">getState</a>()<span class="keyword"> const </span>{
+<a name="l00351"></a>00351                 <span class="keywordflow">return</span> state;
+<a name="l00352"></a>00352         }
+<a name="l00353"></a>00353         <span class="comment"></span>
+<a name="l00354"></a>00354 <span class="comment">        /**</span>
+<a name="l00355"></a>00355 <span class="comment">         * Returns the reason why the parser entered the error state.</span>
+<a name="l00356"></a>00356 <span class="comment">         *</span>
+<a name="l00357"></a>00357 <span class="comment">         * @pre getState() == ERROR</span>
+<a name="l00358"></a>00358 <span class="comment">         */</span>
+<a name="l00359"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#4114253f47d3e7e5c0dddc3cd11c5596">00359</a>         <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#4114253f47d3e7e5c0dddc3cd11c5596" title="Returns the reason why the parser entered the error state.">getErrorReason</a>()<span class="keyword"> const </span>{
+<a name="l00360"></a>00360                 <span class="keywordflow">return</span> errorReason;
+<a name="l00361"></a>00361         }
+<a name="l00362"></a>00362         <span class="comment"></span>
+<a name="l00363"></a>00363 <span class="comment">        /**</span>
+<a name="l00364"></a>00364 <span class="comment">         * Checks whether this parser is still capable of accepting input (that</span>
+<a name="l00365"></a>00365 <span class="comment">         * is, that this parser is not in a final state).</span>
+<a name="l00366"></a>00366 <span class="comment">         */</span>
+<a name="l00367"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#5368ed40bf7c896f68d7ffaae164a092">00367</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#5368ed40bf7c896f68d7ffaae164a092" title="Checks whether this parser is still capable of accepting input (that is, that this...">acceptingInput</a>()<span class="keyword"> const </span>{
+<a name="l00368"></a>00368                 <span class="keywordflow">return</span> state != DONE &amp;&amp; state != ERROR;
+<a name="l00369"></a>00369         }
+<a name="l00370"></a>00370 };
+<a name="l00371"></a>00371 
+<a name="l00372"></a>00372 } <span class="comment">// namespace Passenger</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 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.8 </small></address>
 </body>