doc/cxxapi/Application_8h-source.html in passenger-1.0.5 vs doc/cxxapi/Application_8h-source.html in passenger-2.0.1

- old
+ new

@@ -2,401 +2,447 @@ <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Passenger: Application.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.5.3 --> -<div class="tabs"> - <ul> - <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> - <li><a href="modules.html"><span>Modules</span></a></li> - <li><a href="annotated.html"><span>Classes</span></a></li> - <li class="current"><a href="files.html"><span>Files</span></a></li> - </ul> -</div> +<!-- Generated by Doxygen 1.5.5 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> <h1>Application.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2008 Phusion</span> <a name="l00004"></a>00004 <span class="comment"> *</span> -<a name="l00005"></a>00005 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span> -<a name="l00006"></a>00006 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> -<a name="l00007"></a>00007 <span class="comment"> * the Free Software Foundation; version 2 of the License.</span> -<a name="l00008"></a>00008 <span class="comment"> *</span> -<a name="l00009"></a>00009 <span class="comment"> * This program is distributed in the hope that it will be useful,</span> -<a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> -<a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> -<a name="l00012"></a>00012 <span class="comment"> * GNU General Public License for more details.</span> -<a name="l00013"></a>00013 <span class="comment"> *</span> -<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU General Public License along</span> -<a name="l00015"></a>00015 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span> -<a name="l00016"></a>00016 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span> -<a name="l00017"></a>00017 <span class="comment"> */</span> -<a name="l00018"></a>00018 <span class="preprocessor">#ifndef _PASSENGER_APPLICATION_H_</span> -<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_APPLICATION_H_</span> -<a name="l00020"></a>00020 <span class="preprocessor"></span> -<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span> -<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;boost/function.hpp&gt;</span> -<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;string&gt;</span> -<a name="l00024"></a>00024 -<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;sys/types.h&gt;</span> -<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span> -<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;sys/un.h&gt;</span> -<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;unistd.h&gt;</span> -<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;errno.h&gt;</span> -<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;ctime&gt;</span> -<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;cstring&gt;</span> -<a name="l00032"></a>00032 -<a name="l00033"></a>00033 <span class="preprocessor">#include "MessageChannel.h"</span> -<a name="l00034"></a>00034 <span class="preprocessor">#include "Exceptions.h"</span> -<a name="l00035"></a>00035 <span class="preprocessor">#include "Logging.h"</span> -<a name="l00036"></a>00036 -<a name="l00037"></a>00037 <span class="keyword">namespace </span>Passenger { +<a name="l00005"></a>00005 <span class="comment"> * Phusion Passenger is a trademark of Hongli Lai &amp; Ninh Bui.</span> +<a name="l00006"></a>00006 <span class="comment"> *</span> +<a name="l00007"></a>00007 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span> +<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> +<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; version 2 of the License.</span> +<a name="l00010"></a>00010 <span class="comment"> *</span> +<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span> +<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> +<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> +<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span> +<a name="l00015"></a>00015 <span class="comment"> *</span> +<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License along</span> +<a name="l00017"></a>00017 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span> +<a name="l00018"></a>00018 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span> +<a name="l00019"></a>00019 <span class="comment"> */</span> +<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _PASSENGER_APPLICATION_H_</span> +<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_APPLICATION_H_</span> +<a name="l00022"></a>00022 <span class="preprocessor"></span> +<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span> +<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;boost/function.hpp&gt;</span> +<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;string&gt;</span> +<a name="l00026"></a>00026 +<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;sys/types.h&gt;</span> +<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span> +<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;sys/un.h&gt;</span> +<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;unistd.h&gt;</span> +<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;errno.h&gt;</span> +<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;ctime&gt;</span> +<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;cstring&gt;</span> +<a name="l00034"></a>00034 +<a name="l00035"></a>00035 <span class="preprocessor">#include "MessageChannel.h"</span> +<a name="l00036"></a>00036 <span class="preprocessor">#include "Exceptions.h"</span> +<a name="l00037"></a>00037 <span class="preprocessor">#include "Logging.h"</span> <a name="l00038"></a>00038 -<a name="l00039"></a>00039 <span class="keyword">using namespace </span>std; -<a name="l00040"></a>00040 <span class="keyword">using namespace </span>boost; -<a name="l00041"></a>00041 <span class="comment"></span> -<a name="l00042"></a>00042 <span class="comment">/**</span> -<a name="l00043"></a>00043 <span class="comment"> * Represents a single Ruby on Rails application instance.</span> -<a name="l00044"></a>00044 <span class="comment"> *</span> -<a name="l00045"></a>00045 <span class="comment"> * @ingroup Support</span> -<a name="l00046"></a>00046 <span class="comment"> */</span> -<a name="l00047"></a><a class="code" href="classPassenger_1_1Application.html">00047</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a> { -<a name="l00048"></a>00048 <span class="keyword">public</span>: -<a name="l00049"></a><a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9">00049</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails application...">Session</a>;<span class="comment"></span> -<a name="l00050"></a>00050 <span class="comment"> /** Convenient alias for Session smart pointer. */</span> -<a name="l00051"></a>00051 <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a>; -<a name="l00052"></a>00052 <span class="comment"></span> -<a name="l00053"></a>00053 <span class="comment"> /**</span> -<a name="l00054"></a>00054 <span class="comment"> * Represents the life time of a single request/response pair of a Ruby on Rails</span> -<a name="l00055"></a>00055 <span class="comment"> * application.</span> -<a name="l00056"></a>00056 <span class="comment"> *</span> -<a name="l00057"></a>00057 <span class="comment"> * Session is used to forward a single HTTP request to a Ruby on Rails application.</span> -<a name="l00058"></a>00058 <span class="comment"> * A Session has two communication channels: one for reading data from</span> -<a name="l00059"></a>00059 <span class="comment"> * the RoR application, and one for writing data to the RoR application.</span> -<a name="l00060"></a>00060 <span class="comment"> *</span> -<a name="l00061"></a>00061 <span class="comment"> * In general, a session object is to be used in the following manner:</span> +<a name="l00039"></a><a class="code" href="namespacePassenger.html">00039</a> <span class="keyword">namespace </span>Passenger { +<a name="l00040"></a>00040 +<a name="l00041"></a>00041 <span class="keyword">using namespace </span>std; +<a name="l00042"></a>00042 <span class="keyword">using namespace </span>boost; +<a name="l00043"></a>00043 <span class="comment"></span> +<a name="l00044"></a>00044 <span class="comment">/**</span> +<a name="l00045"></a>00045 <span class="comment"> * Represents a single Ruby on Rails or Rack application instance.</span> +<a name="l00046"></a>00046 <span class="comment"> *</span> +<a name="l00047"></a>00047 <span class="comment"> * @ingroup Support</span> +<a name="l00048"></a>00048 <span class="comment"> */</span> +<a name="l00049"></a><a class="code" href="classPassenger_1_1Application.html">00049</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails or Rack application instance.">Application</a> { +<a name="l00050"></a>00050 <span class="keyword">public</span>: +<a name="l00051"></a><a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9">00051</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails or...">Session</a>;<span class="comment"></span> +<a name="l00052"></a>00052 <span class="comment"> /** Convenient alias for Session smart pointer. */</span> +<a name="l00053"></a>00053 <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a>; +<a name="l00054"></a>00054 <span class="comment"></span> +<a name="l00055"></a>00055 <span class="comment"> /**</span> +<a name="l00056"></a>00056 <span class="comment"> * Represents the life time of a single request/response pair of a</span> +<a name="l00057"></a>00057 <span class="comment"> * Ruby on Rails or Rack application.</span> +<a name="l00058"></a>00058 <span class="comment"> *</span> +<a name="l00059"></a>00059 <span class="comment"> * Session is used to forward a single HTTP request to a Ruby on Rails/Rack</span> +<a name="l00060"></a>00060 <span class="comment"> * application. A Session has two communication channels: one for reading data</span> +<a name="l00061"></a>00061 <span class="comment"> * from the application, and one for writing data to the application.</span> <a name="l00062"></a>00062 <span class="comment"> *</span> -<a name="l00063"></a>00063 <span class="comment"> * -# Convert the HTTP request headers into a string, as expected by sendHeaders().</span> -<a name="l00064"></a>00064 <span class="comment"> * Then send that string by calling sendHeaders().</span> -<a name="l00065"></a>00065 <span class="comment"> * -# In case of a POST of PUT request, send the HTTP request body by calling</span> -<a name="l00066"></a>00066 <span class="comment"> * sendBodyBlock(), possibly multiple times.</span> -<a name="l00067"></a>00067 <span class="comment"> * -# Close the writer channel since you're now done sending data.</span> -<a name="l00068"></a>00068 <span class="comment"> * -# The HTTP response can now be read through the reader channel (getReader()).</span> -<a name="l00069"></a>00069 <span class="comment"> * -# When the HTTP response has been read, the session must be closed.</span> -<a name="l00070"></a>00070 <span class="comment"> * This is done by destroying the Session object.</span> -<a name="l00071"></a>00071 <span class="comment"> *</span> -<a name="l00072"></a>00072 <span class="comment"> * A usage example is shown in Application::connect(). </span> -<a name="l00073"></a>00073 <span class="comment"> */</span> -<a name="l00074"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html">00074</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails application...">Session</a> { -<a name="l00075"></a>00075 <span class="keyword">public</span>: -<a name="l00076"></a>00076 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails application...">Session</a>() {} -<a name="l00077"></a>00077 <span class="comment"></span> +<a name="l00063"></a>00063 <span class="comment"> * In general, a session object is to be used in the following manner:</span> +<a name="l00064"></a>00064 <span class="comment"> *</span> +<a name="l00065"></a>00065 <span class="comment"> * -# Convert the HTTP request headers into a string, as expected by sendHeaders().</span> +<a name="l00066"></a>00066 <span class="comment"> * Then send that string by calling sendHeaders().</span> +<a name="l00067"></a>00067 <span class="comment"> * -# In case of a POST of PUT request, send the HTTP request body by calling</span> +<a name="l00068"></a>00068 <span class="comment"> * sendBodyBlock(), possibly multiple times.</span> +<a name="l00069"></a>00069 <span class="comment"> * -# Shutdown the writer channel since you're now done sending data.</span> +<a name="l00070"></a>00070 <span class="comment"> * -# The HTTP response can now be read through the reader channel (getStream()).</span> +<a name="l00071"></a>00071 <span class="comment"> * -# When the HTTP response has been read, the session must be closed.</span> +<a name="l00072"></a>00072 <span class="comment"> * This is done by destroying the Session object.</span> +<a name="l00073"></a>00073 <span class="comment"> *</span> +<a name="l00074"></a>00074 <span class="comment"> * A usage example is shown in Application::connect(). </span> +<a name="l00075"></a>00075 <span class="comment"> */</span> +<a name="l00076"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html">00076</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails or...">Session</a> { +<a name="l00077"></a>00077 <span class="keyword">public</span>:<span class="comment"></span> <a name="l00078"></a>00078 <span class="comment"> /**</span> -<a name="l00079"></a>00079 <span class="comment"> * Send HTTP request headers to the RoR application. The HTTP headers must be</span> -<a name="l00080"></a>00080 <span class="comment"> * converted into CGI headers, and then encoded into a string that matches this grammar:</span> -<a name="l00081"></a>00081 <span class="comment"> *</span> -<a name="l00082"></a>00082 <span class="comment"> @verbatim</span> -<a name="l00083"></a>00083 <span class="comment"> headers ::= header*</span> -<a name="l00084"></a>00084 <span class="comment"> header ::= name NUL value NUL</span> -<a name="l00085"></a>00085 <span class="comment"> name ::= notnull+</span> -<a name="l00086"></a>00086 <span class="comment"> value ::= notnull+</span> -<a name="l00087"></a>00087 <span class="comment"> notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span> -<a name="l00088"></a>00088 <span class="comment"> NUL = "\x00"</span> -<a name="l00089"></a>00089 <span class="comment"> @endverbatim</span> -<a name="l00090"></a>00090 <span class="comment"> *</span> -<a name="l00091"></a>00091 <span class="comment"> * This method should be the first one to be called during the lifetime of a Session</span> -<a name="l00092"></a>00092 <span class="comment"> * object. Otherwise strange things may happen.</span> -<a name="l00093"></a>00093 <span class="comment"> *</span> -<a name="l00094"></a>00094 <span class="comment"> * @param headers The HTTP request headers, converted into CGI headers and encoded as</span> -<a name="l00095"></a>00095 <span class="comment"> * a string, according to the description.</span> -<a name="l00096"></a>00096 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span> -<a name="l00097"></a>00097 <span class="comment"> * @pre headers != NULL</span> -<a name="l00098"></a>00098 <span class="comment"> * @throws IOException The writer channel has already been closed.</span> -<a name="l00099"></a>00099 <span class="comment"> * @throws SystemException Something went wrong during writing.</span> -<a name="l00100"></a>00100 <span class="comment"> */</span> -<a name="l00101"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360">00101</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the RoR application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *headers, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) { -<a name="l00102"></a>00102 <span class="keywordtype">int</span> writer = <a class="code" href="classPassenger_1_1Application_1_1Session.html#ffdb4345b8fd695e66d123cb62a9b160" title="Get the writer channel&amp;#39;s file descriptor.">getWriter</a>(); -<a name="l00103"></a>00103 <span class="keywordflow">if</span> (writer == -1) { -<a name="l00104"></a>00104 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write headers to the request handler because the writer channel has already been closed."</span>); -<a name="l00105"></a>00105 } -<a name="l00106"></a>00106 <span class="keywordflow">try</span> { -<a name="l00107"></a>00107 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(writer).writeScalar(headers, size); -<a name="l00108"></a>00108 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) { -<a name="l00109"></a>00109 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"An error occured while writing headers to the request handler"</span>, e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); -<a name="l00110"></a>00110 } -<a name="l00111"></a>00111 } -<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"> * Convenience shortcut for sendHeaders(const char *, unsigned int)</span> -<a name="l00115"></a>00115 <span class="comment"> * @param headers</span> -<a name="l00116"></a>00116 <span class="comment"> * @throws IOException The writer channel has already been closed.</span> -<a name="l00117"></a>00117 <span class="comment"> * @throws SystemException Something went wrong during writing.</span> -<a name="l00118"></a>00118 <span class="comment"> */</span> -<a name="l00119"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fee03667f626d68c565495bcb19771a">00119</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the RoR application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;headers) { -<a name="l00120"></a>00120 <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the RoR application.">sendHeaders</a>(headers.c_str(), headers.size()); -<a name="l00121"></a>00121 } -<a name="l00122"></a>00122 <span class="comment"></span> -<a name="l00123"></a>00123 <span class="comment"> /**</span> -<a name="l00124"></a>00124 <span class="comment"> * Send a chunk of HTTP request body data to the RoR application.</span> -<a name="l00125"></a>00125 <span class="comment"> * You can call this method as many times as is required to transfer</span> -<a name="l00126"></a>00126 <span class="comment"> * the entire HTTP request body.</span> -<a name="l00127"></a>00127 <span class="comment"> *</span> -<a name="l00128"></a>00128 <span class="comment"> * This method should only be called after a sendHeaders(). Otherwise</span> -<a name="l00129"></a>00129 <span class="comment"> * strange things may happen.</span> -<a name="l00130"></a>00130 <span class="comment"> *</span> -<a name="l00131"></a>00131 <span class="comment"> * @param block A block of HTTP request body data to send.</span> -<a name="l00132"></a>00132 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span> -<a name="l00133"></a>00133 <span class="comment"> * @throws IOException The writer channel has already been closed.</span> -<a name="l00134"></a>00134 <span class="comment"> * @throws SystemException Something went wrong during writing.</span> -<a name="l00135"></a>00135 <span class="comment"> */</span> -<a name="l00136"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669">00136</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669" title="Send a chunk of HTTP request body data to the RoR application.">sendBodyBlock</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *block, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) { -<a name="l00137"></a>00137 <span class="keywordtype">int</span> writer = <a class="code" href="classPassenger_1_1Application_1_1Session.html#ffdb4345b8fd695e66d123cb62a9b160" title="Get the writer channel&amp;#39;s file descriptor.">getWriter</a>(); -<a name="l00138"></a>00138 <span class="keywordflow">if</span> (writer == -1) { -<a name="l00139"></a>00139 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write request body block to the request handler because the writer channel has already been closed."</span>); -<a name="l00140"></a>00140 } -<a name="l00141"></a>00141 <span class="keywordflow">try</span> { -<a name="l00142"></a>00142 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(writer).writeRaw(block, size); -<a name="l00143"></a>00143 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) { -<a name="l00144"></a>00144 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"An error occured while request body to the request handler"</span>, e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); -<a name="l00145"></a>00145 } -<a name="l00146"></a>00146 } -<a name="l00147"></a>00147 <span class="comment"></span> -<a name="l00148"></a>00148 <span class="comment"> /**</span> -<a name="l00149"></a>00149 <span class="comment"> * Get the reader channel's file descriptor.</span> -<a name="l00150"></a>00150 <span class="comment"> *</span> -<a name="l00151"></a>00151 <span class="comment"> * @pre The reader channel has not been closed.</span> -<a name="l00152"></a>00152 <span class="comment"> */</span> -<a name="l00153"></a>00153 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#5635d9d04f400b0caefaacf1e4859c02" title="Get the reader channel&amp;#39;s file descriptor.">getReader</a>() <span class="keyword">const</span> = 0; -<a name="l00154"></a>00154 <span class="comment"></span> -<a name="l00155"></a>00155 <span class="comment"> /**</span> -<a name="l00156"></a>00156 <span class="comment"> * Close the reader channel. This method may be safely called multiple times.</span> -<a name="l00157"></a>00157 <span class="comment"> */</span> -<a name="l00158"></a>00158 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#49230041744ff4e48ddd3358febd56a9" title="Close the reader channel.">closeReader</a>() = 0; -<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"> * Get the writer channel's file descriptor. You should rarely have to</span> -<a name="l00162"></a>00162 <span class="comment"> * use this directly. One should only use sendHeaders() and sendBodyBlock()</span> -<a name="l00163"></a>00163 <span class="comment"> * whenever possible.</span> -<a name="l00164"></a>00164 <span class="comment"> *</span> -<a name="l00165"></a>00165 <span class="comment"> * @pre The writer channel has not been closed.</span> -<a name="l00166"></a>00166 <span class="comment"> */</span> -<a name="l00167"></a>00167 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#ffdb4345b8fd695e66d123cb62a9b160" title="Get the writer channel&amp;#39;s file descriptor.">getWriter</a>() <span class="keyword">const</span> = 0; -<a name="l00168"></a>00168 <span class="comment"></span> -<a name="l00169"></a>00169 <span class="comment"> /**</span> -<a name="l00170"></a>00170 <span class="comment"> * Close the writer channel. This method may be safely called multiple times.</span> -<a name="l00171"></a>00171 <span class="comment"> */</span> -<a name="l00172"></a>00172 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#ecaa3575efd70130a4adfec203120d74" title="Close the writer channel.">closeWriter</a>() = 0; -<a name="l00173"></a>00173 <span class="comment"></span> -<a name="l00174"></a>00174 <span class="comment"> /**</span> -<a name="l00175"></a>00175 <span class="comment"> * Get the process ID of the application instance that belongs to this session.</span> +<a name="l00079"></a>00079 <span class="comment"> * Implementing classes might throw arbitrary exceptions.</span> +<a name="l00080"></a>00080 <span class="comment"> */</span> +<a name="l00081"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c">00081</a> <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#4fcaf0670234f7fb2ea6de4b8d8ef38c" title="Implementing classes might throw arbitrary exceptions.">~Session</a>() {} +<a name="l00082"></a>00082 <span class="comment"></span> +<a name="l00083"></a>00083 <span class="comment"> /**</span> +<a name="l00084"></a>00084 <span class="comment"> * Send HTTP request headers to the application. The HTTP headers must be</span> +<a name="l00085"></a>00085 <span class="comment"> * converted into CGI headers, and then encoded into a string that matches this grammar:</span> +<a name="l00086"></a>00086 <span class="comment"> *</span> +<a name="l00087"></a>00087 <span class="comment"> @verbatim</span> +<a name="l00088"></a>00088 <span class="comment"> headers ::= header*</span> +<a name="l00089"></a>00089 <span class="comment"> header ::= name NUL value NUL</span> +<a name="l00090"></a>00090 <span class="comment"> name ::= notnull+</span> +<a name="l00091"></a>00091 <span class="comment"> value ::= notnull+</span> +<a name="l00092"></a>00092 <span class="comment"> notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span> +<a name="l00093"></a>00093 <span class="comment"> NUL = "\x00"</span> +<a name="l00094"></a>00094 <span class="comment"> @endverbatim</span> +<a name="l00095"></a>00095 <span class="comment"> *</span> +<a name="l00096"></a>00096 <span class="comment"> * This method should be the first one to be called during the lifetime of a Session</span> +<a name="l00097"></a>00097 <span class="comment"> * object. Otherwise strange things may happen.</span> +<a name="l00098"></a>00098 <span class="comment"> *</span> +<a name="l00099"></a>00099 <span class="comment"> * @param headers The HTTP request headers, converted into CGI headers and encoded as</span> +<a name="l00100"></a>00100 <span class="comment"> * a string, according to the description.</span> +<a name="l00101"></a>00101 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span> +<a name="l00102"></a>00102 <span class="comment"> * @pre headers != NULL</span> +<a name="l00103"></a>00103 <span class="comment"> * @throws IOException The writer channel has already been closed.</span> +<a name="l00104"></a>00104 <span class="comment"> * @throws SystemException Something went wrong during writing.</span> +<a name="l00105"></a>00105 <span class="comment"> * @throws boost::thread_interrupted</span> +<a name="l00106"></a>00106 <span class="comment"> */</span> +<a name="l00107"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360">00107</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *headers, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) { +<a name="l00108"></a>00108 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>(); +<a name="l00109"></a>00109 <span class="keywordflow">if</span> (stream == -1) { +<a name="l00110"></a>00110 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write headers to the request handler "</span> +<a name="l00111"></a>00111 <span class="stringliteral">"because the writer stream has already been closed."</span>); +<a name="l00112"></a>00112 } +<a name="l00113"></a>00113 <span class="keywordflow">try</span> { +<a name="l00114"></a>00114 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeScalar(headers, size); +<a name="l00115"></a>00115 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) { +<a name="l00116"></a>00116 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"An error occured while writing headers "</span> +<a name="l00117"></a>00117 <span class="stringliteral">"to the request handler"</span>, e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); +<a name="l00118"></a>00118 } +<a name="l00119"></a>00119 } +<a name="l00120"></a>00120 <span class="comment"></span> +<a name="l00121"></a>00121 <span class="comment"> /**</span> +<a name="l00122"></a>00122 <span class="comment"> * Convenience shortcut for sendHeaders(const char *, unsigned int)</span> +<a name="l00123"></a>00123 <span class="comment"> * @param headers</span> +<a name="l00124"></a>00124 <span class="comment"> * @throws IOException The writer channel has already been closed.</span> +<a name="l00125"></a>00125 <span class="comment"> * @throws SystemException Something went wrong during writing.</span> +<a name="l00126"></a>00126 <span class="comment"> * @throws boost::thread_interrupted</span> +<a name="l00127"></a>00127 <span class="comment"> */</span> +<a name="l00128"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#4fee03667f626d68c565495bcb19771a">00128</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;headers) { +<a name="l00129"></a>00129 <a class="code" href="classPassenger_1_1Application_1_1Session.html#78a4c93fd80f6d913f092c488ea4d360" title="Send HTTP request headers to the application.">sendHeaders</a>(headers.c_str(), headers.size()); +<a name="l00130"></a>00130 } +<a name="l00131"></a>00131 <span class="comment"></span> +<a name="l00132"></a>00132 <span class="comment"> /**</span> +<a name="l00133"></a>00133 <span class="comment"> * Send a chunk of HTTP request body data to the application.</span> +<a name="l00134"></a>00134 <span class="comment"> * You can call this method as many times as is required to transfer</span> +<a name="l00135"></a>00135 <span class="comment"> * the entire HTTP request body.</span> +<a name="l00136"></a>00136 <span class="comment"> *</span> +<a name="l00137"></a>00137 <span class="comment"> * This method should only be called after a sendHeaders(). Otherwise</span> +<a name="l00138"></a>00138 <span class="comment"> * strange things may happen.</span> +<a name="l00139"></a>00139 <span class="comment"> *</span> +<a name="l00140"></a>00140 <span class="comment"> * @param block A block of HTTP request body data to send.</span> +<a name="l00141"></a>00141 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span> +<a name="l00142"></a>00142 <span class="comment"> * @throws IOException The writer channel has already been closed.</span> +<a name="l00143"></a>00143 <span class="comment"> * @throws SystemException Something went wrong during writing.</span> +<a name="l00144"></a>00144 <span class="comment"> * @throws boost::thread_interrupted</span> +<a name="l00145"></a>00145 <span class="comment"> */</span> +<a name="l00146"></a><a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669">00146</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2091e4b60dcbe42ab80fa387610fd669" title="Send a chunk of HTTP request body data to the application.">sendBodyBlock</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *block, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) { +<a name="l00147"></a>00147 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>(); +<a name="l00148"></a>00148 <span class="keywordflow">if</span> (stream == -1) { +<a name="l00149"></a>00149 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write request body block to the "</span> +<a name="l00150"></a>00150 <span class="stringliteral">"request handler because the writer stream has "</span> +<a name="l00151"></a>00151 <span class="stringliteral">"already been closed."</span>); +<a name="l00152"></a>00152 } +<a name="l00153"></a>00153 <span class="keywordflow">try</span> { +<a name="l00154"></a>00154 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeRaw(block, size); +<a name="l00155"></a>00155 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) { +<a name="l00156"></a>00156 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"An error occured while sending the "</span> +<a name="l00157"></a>00157 <span class="stringliteral">"request body to the request handler"</span>, e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); +<a name="l00158"></a>00158 } +<a name="l00159"></a>00159 } +<a name="l00160"></a>00160 <span class="comment"></span> +<a name="l00161"></a>00161 <span class="comment"> /**</span> +<a name="l00162"></a>00162 <span class="comment"> * Get the I/O stream's file descriptor. This steam is full-duplex,</span> +<a name="l00163"></a>00163 <span class="comment"> * and will be automatically closed upon Session's destruction,</span> +<a name="l00164"></a>00164 <span class="comment"> * unless discardStream() is called.</span> +<a name="l00165"></a>00165 <span class="comment"> *</span> +<a name="l00166"></a>00166 <span class="comment"> * @pre The stream has not been fully closed.</span> +<a name="l00167"></a>00167 <span class="comment"> */</span> +<a name="l00168"></a>00168 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#2631b6d6b4927ec66b1f620df15d8c6e" title="Get the I/O stream&amp;#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0; +<a name="l00169"></a>00169 <span class="comment"></span> +<a name="l00170"></a>00170 <span class="comment"> /**</span> +<a name="l00171"></a>00171 <span class="comment"> * Indicate that we don't want to read data anymore from the I/O stream.</span> +<a name="l00172"></a>00172 <span class="comment"> * Calling this method after closeStream() is called will have no effect.</span> +<a name="l00173"></a>00173 <span class="comment"> *</span> +<a name="l00174"></a>00174 <span class="comment"> * @throws SystemException Something went wrong.</span> +<a name="l00175"></a>00175 <span class="comment"> * @throws boost::thread_interrupted</span> <a name="l00176"></a>00176 <span class="comment"> */</span> -<a name="l00177"></a>00177 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application_1_1Session.html#2215bec32917c48d1a9f6386b88d018b" title="Get the process ID of the application instance that belongs to this session.">getPid</a>() <span class="keyword">const</span> = 0; -<a name="l00178"></a>00178 }; -<a name="l00179"></a>00179 -<a name="l00180"></a>00180 <span class="keyword">private</span>:<span class="comment"></span> -<a name="l00181"></a>00181 <span class="comment"> /**</span> -<a name="l00182"></a>00182 <span class="comment"> * A "standard" implementation of Session.</span> -<a name="l00183"></a>00183 <span class="comment"> */</span> -<a name="l00184"></a>00184 <span class="keyword">class </span>StandardSession: <span class="keyword">public</span> Session { -<a name="l00185"></a>00185 <span class="keyword">protected</span>: -<a name="l00186"></a>00186 function&lt;void()&gt; closeCallback; -<a name="l00187"></a>00187 <span class="keywordtype">bool</span> readerClosed, writerClosed; -<a name="l00188"></a>00188 <span class="keywordtype">int</span> fd; -<a name="l00189"></a>00189 pid_t pid; -<a name="l00190"></a>00190 -<a name="l00191"></a>00191 <span class="keyword">public</span>: -<a name="l00192"></a>00192 StandardSession(pid_t pid, -<a name="l00193"></a>00193 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback, -<a name="l00194"></a>00194 <span class="keywordtype">int</span> fd) { -<a name="l00195"></a>00195 this-&gt;pid = pid; -<a name="l00196"></a>00196 this-&gt;closeCallback = closeCallback; -<a name="l00197"></a>00197 this-&gt;fd = fd; -<a name="l00198"></a>00198 readerClosed = writerClosed = <span class="keyword">false</span>; -<a name="l00199"></a>00199 } -<a name="l00200"></a>00200 -<a name="l00201"></a>00201 <span class="keyword">virtual</span> ~StandardSession() { -<a name="l00202"></a>00202 closeReader(); -<a name="l00203"></a>00203 closeWriter(); -<a name="l00204"></a>00204 closeCallback(); -<a name="l00205"></a>00205 } -<a name="l00206"></a>00206 -<a name="l00207"></a>00207 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getReader()<span class="keyword"> const </span>{ -<a name="l00208"></a>00208 <span class="keywordflow">return</span> fd; -<a name="l00209"></a>00209 } -<a name="l00210"></a>00210 -<a name="l00211"></a>00211 <span class="keyword">virtual</span> <span class="keywordtype">void</span> closeReader() { -<a name="l00212"></a>00212 readerClosed = <span class="keyword">true</span>; -<a name="l00213"></a>00213 <span class="keywordflow">if</span> (readerClosed &amp;&amp; writerClosed &amp;&amp; fd != -1) { -<a name="l00214"></a>00214 close(fd); -<a name="l00215"></a>00215 fd = -1; -<a name="l00216"></a>00216 } -<a name="l00217"></a>00217 } -<a name="l00218"></a>00218 -<a name="l00219"></a>00219 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getWriter()<span class="keyword"> const </span>{ -<a name="l00220"></a>00220 <span class="keywordflow">return</span> fd; -<a name="l00221"></a>00221 } -<a name="l00222"></a>00222 -<a name="l00223"></a>00223 <span class="keyword">virtual</span> <span class="keywordtype">void</span> closeWriter() { -<a name="l00224"></a>00224 writerClosed = <span class="keyword">true</span>; -<a name="l00225"></a>00225 <span class="keywordflow">if</span> (readerClosed &amp;&amp; writerClosed &amp;&amp; fd != -1) { -<a name="l00226"></a>00226 close(fd); -<a name="l00227"></a>00227 fd = -1; -<a name="l00228"></a>00228 } -<a name="l00229"></a>00229 } -<a name="l00230"></a>00230 -<a name="l00231"></a>00231 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{ -<a name="l00232"></a>00232 <span class="keywordflow">return</span> pid; -<a name="l00233"></a>00233 } -<a name="l00234"></a>00234 }; -<a name="l00235"></a>00235 -<a name="l00236"></a>00236 <span class="keywordtype">string</span> appRoot; -<a name="l00237"></a>00237 pid_t pid; -<a name="l00238"></a>00238 <span class="keywordtype">string</span> listenSocketName; -<a name="l00239"></a>00239 <span class="keywordtype">bool</span> usingAbstractNamespace; -<a name="l00240"></a>00240 <span class="keywordtype">int</span> ownerPipe; -<a name="l00241"></a>00241 -<a name="l00242"></a>00242 <span class="keyword">public</span>:<span class="comment"></span> -<a name="l00243"></a>00243 <span class="comment"> /**</span> -<a name="l00244"></a>00244 <span class="comment"> * Construct a new Application object.</span> -<a name="l00245"></a>00245 <span class="comment"> *</span> -<a name="l00246"></a>00246 <span class="comment"> * @param theAppRoot The application root of a RoR application, i.e. the folder that</span> -<a name="l00247"></a>00247 <span class="comment"> * contains 'app/', 'public/', 'config/', etc. This must be a valid directory,</span> -<a name="l00248"></a>00248 <span class="comment"> * but the path does not have to be absolute.</span> -<a name="l00249"></a>00249 <span class="comment"> * @param pid The process ID of this application instance.</span> -<a name="l00250"></a>00250 <span class="comment"> * @param listenSocketName The name of the listener socket of this application instance.</span> -<a name="l00251"></a>00251 <span class="comment"> * @param usingAbstractNamespace Whether &lt;tt&gt;listenSocketName&lt;/tt&gt; refers to a Unix</span> -<a name="l00252"></a>00252 <span class="comment"> * socket on the abstract namespace. Note that listenSocketName must not</span> -<a name="l00253"></a>00253 <span class="comment"> * contain the leading null byte, even if it's an abstract namespace socket.</span> -<a name="l00254"></a>00254 <span class="comment"> * @param ownerPipe The owner pipe of this application instance.</span> -<a name="l00255"></a>00255 <span class="comment"> * @post getAppRoot() == theAppRoot &amp;&amp; getPid() == pid</span> -<a name="l00256"></a>00256 <span class="comment"> */</span> -<a name="l00257"></a><a class="code" href="classPassenger_1_1Application.html#163509167eef118470b72661ac8acd5d">00257</a> <a class="code" href="classPassenger_1_1Application.html#163509167eef118470b72661ac8acd5d" title="Construct a new Application object.">Application</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;theAppRoot, pid_t pid, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;listenSocketName, -<a name="l00258"></a>00258 <span class="keywordtype">bool</span> usingAbstractNamespace, <span class="keywordtype">int</span> ownerPipe) { -<a name="l00259"></a>00259 appRoot = theAppRoot; -<a name="l00260"></a>00260 this-&gt;pid = pid; -<a name="l00261"></a>00261 this-&gt;listenSocketName = listenSocketName; -<a name="l00262"></a>00262 this-&gt;usingAbstractNamespace = usingAbstractNamespace; -<a name="l00263"></a>00263 this-&gt;ownerPipe = ownerPipe; -<a name="l00264"></a>00264 P_TRACE(2, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": created."</span>); -<a name="l00265"></a>00265 } -<a name="l00266"></a>00266 -<a name="l00267"></a>00267 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>() { -<a name="l00268"></a>00268 <span class="keywordflow">if</span> (ownerPipe != -1) { -<a name="l00269"></a>00269 close(ownerPipe); -<a name="l00270"></a>00270 } -<a name="l00271"></a>00271 <span class="keywordflow">if</span> (!usingAbstractNamespace) { -<a name="l00272"></a>00272 unlink(listenSocketName.c_str()); +<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#45ad442dc1f4e7b73782bb3395d9e97d" title="Indicate that we don&amp;#39;t want to read data anymore from the I/O stream.">shutdownReader</a>() = 0; +<a name="l00178"></a>00178 <span class="comment"></span> +<a name="l00179"></a>00179 <span class="comment"> /**</span> +<a name="l00180"></a>00180 <span class="comment"> * Indicate that we don't want to write data anymore to the I/O stream.</span> +<a name="l00181"></a>00181 <span class="comment"> * Calling this method after closeStream() is called will have no effect.</span> +<a name="l00182"></a>00182 <span class="comment"> *</span> +<a name="l00183"></a>00183 <span class="comment"> * @throws SystemException Something went wrong.</span> +<a name="l00184"></a>00184 <span class="comment"> * @throws boost::thread_interrupted</span> +<a name="l00185"></a>00185 <span class="comment"> */</span> +<a name="l00186"></a>00186 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#dff449398adb872c93a9572ae4b701fb" title="Indicate that we don&amp;#39;t want to write data anymore to the I/O stream.">shutdownWriter</a>() = 0; +<a name="l00187"></a>00187 <span class="comment"></span> +<a name="l00188"></a>00188 <span class="comment"> /**</span> +<a name="l00189"></a>00189 <span class="comment"> * Close the I/O stream.</span> +<a name="l00190"></a>00190 <span class="comment"> *</span> +<a name="l00191"></a>00191 <span class="comment"> * @throws SystemException Something went wrong.</span> +<a name="l00192"></a>00192 <span class="comment"> * @throws boost::thread_interrupted</span> +<a name="l00193"></a>00193 <span class="comment"> */</span> +<a name="l00194"></a>00194 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#ddfeda914b17749a70016f5eb384f8a9" title="Close the I/O stream.">closeStream</a>() = 0; +<a name="l00195"></a>00195 <span class="comment"></span> +<a name="l00196"></a>00196 <span class="comment"> /**</span> +<a name="l00197"></a>00197 <span class="comment"> * Discard the I/O stream's file descriptor, so that Session won't automatically</span> +<a name="l00198"></a>00198 <span class="comment"> * closed it upon Session's destruction.</span> +<a name="l00199"></a>00199 <span class="comment"> */</span> +<a name="l00200"></a>00200 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Application_1_1Session.html#7f9ad70e75d21130d914d2134061c757" title="Discard the I/O stream&amp;#39;s file descriptor, so that Session won&amp;#39;t automatically...">discardStream</a>() = 0; +<a name="l00201"></a>00201 <span class="comment"></span> +<a name="l00202"></a>00202 <span class="comment"> /**</span> +<a name="l00203"></a>00203 <span class="comment"> * Get the process ID of the application instance that belongs to this session.</span> +<a name="l00204"></a>00204 <span class="comment"> */</span> +<a name="l00205"></a>00205 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application_1_1Session.html#2215bec32917c48d1a9f6386b88d018b" title="Get the process ID of the application instance that belongs to this session.">getPid</a>() <span class="keyword">const</span> = 0; +<a name="l00206"></a>00206 }; +<a name="l00207"></a>00207 +<a name="l00208"></a>00208 <span class="keyword">private</span>:<span class="comment"></span> +<a name="l00209"></a>00209 <span class="comment"> /**</span> +<a name="l00210"></a>00210 <span class="comment"> * A "standard" implementation of Session.</span> +<a name="l00211"></a>00211 <span class="comment"> */</span> +<a name="l00212"></a>00212 <span class="keyword">class </span>StandardSession: <span class="keyword">public</span> Session { +<a name="l00213"></a>00213 <span class="keyword">protected</span>: +<a name="l00214"></a>00214 function&lt;void()&gt; closeCallback; +<a name="l00215"></a>00215 <span class="keywordtype">int</span> fd; +<a name="l00216"></a>00216 pid_t pid; +<a name="l00217"></a>00217 +<a name="l00218"></a>00218 <span class="keyword">public</span>: +<a name="l00219"></a>00219 StandardSession(pid_t pid, +<a name="l00220"></a>00220 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback, +<a name="l00221"></a>00221 <span class="keywordtype">int</span> fd) { +<a name="l00222"></a>00222 this-&gt;pid = pid; +<a name="l00223"></a>00223 this-&gt;closeCallback = closeCallback; +<a name="l00224"></a>00224 this-&gt;fd = fd; +<a name="l00225"></a>00225 } +<a name="l00226"></a>00226 +<a name="l00227"></a>00227 <span class="keyword">virtual</span> ~StandardSession() { +<a name="l00228"></a>00228 closeStream(); +<a name="l00229"></a>00229 closeCallback(); +<a name="l00230"></a>00230 } +<a name="l00231"></a>00231 +<a name="l00232"></a>00232 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getStream()<span class="keyword"> const </span>{ +<a name="l00233"></a>00233 <span class="keywordflow">return</span> fd; +<a name="l00234"></a>00234 } +<a name="l00235"></a>00235 +<a name="l00236"></a>00236 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdownReader() { +<a name="l00237"></a>00237 <span class="keywordflow">if</span> (fd != -1) { +<a name="l00238"></a>00238 <span class="keywordtype">int</span> ret = InterruptableCalls::shutdown(fd, SHUT_RD); +<a name="l00239"></a>00239 <span class="keywordflow">if</span> (ret == -1) { +<a name="l00240"></a>00240 <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot shutdown the writer stream"</span>, +<a name="l00241"></a>00241 errno); +<a name="l00242"></a>00242 } +<a name="l00243"></a>00243 } +<a name="l00244"></a>00244 } +<a name="l00245"></a>00245 +<a name="l00246"></a>00246 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdownWriter() { +<a name="l00247"></a>00247 <span class="keywordflow">if</span> (fd != -1) { +<a name="l00248"></a>00248 <span class="keywordtype">int</span> ret = InterruptableCalls::shutdown(fd, SHUT_WR); +<a name="l00249"></a>00249 <span class="keywordflow">if</span> (ret == -1) { +<a name="l00250"></a>00250 <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot shutdown the writer stream"</span>, +<a name="l00251"></a>00251 errno); +<a name="l00252"></a>00252 } +<a name="l00253"></a>00253 } +<a name="l00254"></a>00254 } +<a name="l00255"></a>00255 +<a name="l00256"></a>00256 <span class="keyword">virtual</span> <span class="keywordtype">void</span> closeStream() { +<a name="l00257"></a>00257 <span class="keywordflow">if</span> (fd != -1) { +<a name="l00258"></a>00258 <span class="keywordtype">int</span> ret = InterruptableCalls::close(fd); +<a name="l00259"></a>00259 <span class="keywordflow">if</span> (ret == -1) { +<a name="l00260"></a>00260 <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot close the session stream"</span>, +<a name="l00261"></a>00261 errno); +<a name="l00262"></a>00262 } +<a name="l00263"></a>00263 fd = -1; +<a name="l00264"></a>00264 } +<a name="l00265"></a>00265 } +<a name="l00266"></a>00266 +<a name="l00267"></a>00267 <span class="keyword">virtual</span> <span class="keywordtype">void</span> discardStream() { +<a name="l00268"></a>00268 fd = -1; +<a name="l00269"></a>00269 } +<a name="l00270"></a>00270 +<a name="l00271"></a>00271 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{ +<a name="l00272"></a>00272 <span class="keywordflow">return</span> pid; <a name="l00273"></a>00273 } -<a name="l00274"></a>00274 P_TRACE(2, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": destroyed."</span>); -<a name="l00275"></a>00275 } -<a name="l00276"></a>00276 <span class="comment"></span> -<a name="l00277"></a>00277 <span class="comment"> /**</span> -<a name="l00278"></a>00278 <span class="comment"> * Returns the application root for this RoR application. See the constructor</span> -<a name="l00279"></a>00279 <span class="comment"> * for information about the application root.</span> -<a name="l00280"></a>00280 <span class="comment"> */</span> -<a name="l00281"></a><a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56">00281</a> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this RoR application.">getAppRoot</a>()<span class="keyword"> const </span>{ -<a name="l00282"></a>00282 <span class="keywordflow">return</span> appRoot; -<a name="l00283"></a>00283 } -<a name="l00284"></a>00284 <span class="comment"></span> -<a name="l00285"></a>00285 <span class="comment"> /**</span> -<a name="l00286"></a>00286 <span class="comment"> * Returns the process ID of this application instance.</span> -<a name="l00287"></a>00287 <span class="comment"> */</span> -<a name="l00288"></a><a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02">00288</a> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{ -<a name="l00289"></a>00289 <span class="keywordflow">return</span> pid; -<a name="l00290"></a>00290 } -<a name="l00291"></a>00291 <span class="comment"></span> -<a name="l00292"></a>00292 <span class="comment"> /**</span> -<a name="l00293"></a>00293 <span class="comment"> * Connect to this application instance with the purpose of sending</span> -<a name="l00294"></a>00294 <span class="comment"> * a request to the application. Once connected, a new session will</span> -<a name="l00295"></a>00295 <span class="comment"> * be opened. This session represents the life time of a single</span> -<a name="l00296"></a>00296 <span class="comment"> * request/response pair, and can be used to send the request</span> -<a name="l00297"></a>00297 <span class="comment"> * data to the application instance, as well as receiving the response</span> -<a name="l00298"></a>00298 <span class="comment"> * data.</span> -<a name="l00299"></a>00299 <span class="comment"> *</span> -<a name="l00300"></a>00300 <span class="comment"> * The use of connect() is demonstrated in the following example.</span> -<a name="l00301"></a>00301 <span class="comment"> * @code</span> -<a name="l00302"></a>00302 <span class="comment"> * // Connect to the application and get the newly opened session.</span> -<a name="l00303"></a>00303 <span class="comment"> * Application::SessionPtr session(app-&gt;connect("/home/webapps/foo"));</span> -<a name="l00304"></a>00304 <span class="comment"> * </span> -<a name="l00305"></a>00305 <span class="comment"> * // Send the request headers and request body data.</span> -<a name="l00306"></a>00306 <span class="comment"> * session-&gt;sendHeaders(...);</span> -<a name="l00307"></a>00307 <span class="comment"> * session-&gt;sendBodyBlock(...);</span> -<a name="l00308"></a>00308 <span class="comment"> * // Done sending data, so we close the writer channel.</span> -<a name="l00309"></a>00309 <span class="comment"> * session-&gt;closeWriter();</span> -<a name="l00310"></a>00310 <span class="comment"> *</span> -<a name="l00311"></a>00311 <span class="comment"> * // Now read the HTTP response.</span> -<a name="l00312"></a>00312 <span class="comment"> * string responseData = readAllDataFromSocket(session-&gt;getReader());</span> -<a name="l00313"></a>00313 <span class="comment"> * // Done reading data, so we close the reader channel.</span> -<a name="l00314"></a>00314 <span class="comment"> * session-&gt;closeReader();</span> -<a name="l00315"></a>00315 <span class="comment"> *</span> -<a name="l00316"></a>00316 <span class="comment"> * // This session has now finished, so we close the session by resetting</span> -<a name="l00317"></a>00317 <span class="comment"> * // the smart pointer to NULL (thereby destroying the Session object).</span> -<a name="l00318"></a>00318 <span class="comment"> * session.reset();</span> -<a name="l00319"></a>00319 <span class="comment"> *</span> -<a name="l00320"></a>00320 <span class="comment"> * // We can connect to an Application multiple times. Just make sure</span> -<a name="l00321"></a>00321 <span class="comment"> * // the previous session is closed.</span> -<a name="l00322"></a>00322 <span class="comment"> * session = app-&gt;connect("/home/webapps/bar")</span> -<a name="l00323"></a>00323 <span class="comment"> * @endcode</span> -<a name="l00324"></a>00324 <span class="comment"> *</span> -<a name="l00325"></a>00325 <span class="comment"> * Note that a RoR application instance can only process one</span> -<a name="l00326"></a>00326 <span class="comment"> * request at the same time, and thus only one session at the same time.</span> -<a name="l00327"></a>00327 <span class="comment"> * You &lt;b&gt;must&lt;/b&gt; close a session when you no longer need if. You you</span> -<a name="l00328"></a>00328 <span class="comment"> * call connect() without having properly closed a previous session,</span> -<a name="l00329"></a>00329 <span class="comment"> * you might cause a deadlock because the application instance may be</span> -<a name="l00330"></a>00330 <span class="comment"> * waiting for you to close the previous session.</span> -<a name="l00331"></a>00331 <span class="comment"> *</span> -<a name="l00332"></a>00332 <span class="comment"> * @return A smart pointer to a Session object, which represents the created session.</span> -<a name="l00333"></a>00333 <span class="comment"> * @param closeCallback A function which will be called when the session has been closed.</span> -<a name="l00334"></a>00334 <span class="comment"> * @post this-&gt;getSessions() == old-&gt;getSessions() + 1</span> -<a name="l00335"></a>00335 <span class="comment"> * @throws SystemException Something went wrong during the connection process.</span> -<a name="l00336"></a>00336 <span class="comment"> * @throws IOException Something went wrong during the connection process.</span> -<a name="l00337"></a>00337 <span class="comment"> */</span> -<a name="l00338"></a><a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379">00338</a> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> <a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the...">connect</a>(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback)<span class="keyword"> const </span>{ -<a name="l00339"></a>00339 <span class="keywordtype">int</span> fd, ret; -<a name="l00340"></a>00340 -<a name="l00341"></a>00341 <span class="keywordflow">do</span> { -<a name="l00342"></a>00342 fd = socket(PF_UNIX, SOCK_STREAM, 0); -<a name="l00343"></a>00343 } <span class="keywordflow">while</span> (fd == -1 &amp;&amp; errno == EINTR); -<a name="l00344"></a>00344 <span class="keywordflow">if</span> (fd == -1) { -<a name="l00345"></a>00345 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot create a new unconnected Unix socket"</span>, errno); -<a name="l00346"></a>00346 } -<a name="l00347"></a>00347 -<a name="l00348"></a>00348 <span class="keyword">struct </span>sockaddr_un addr; -<a name="l00349"></a>00349 addr.sun_family = AF_UNIX; -<a name="l00350"></a>00350 <span class="keywordflow">if</span> (usingAbstractNamespace) { -<a name="l00351"></a>00351 strncpy(addr.sun_path + 1, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path) - 1); -<a name="l00352"></a>00352 addr.sun_path[0] = <span class="charliteral">'\0'</span>; -<a name="l00353"></a>00353 } <span class="keywordflow">else</span> { -<a name="l00354"></a>00354 strncpy(addr.sun_path, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path)); -<a name="l00355"></a>00355 } -<a name="l00356"></a>00356 addr.sun_path[<span class="keyword">sizeof</span>(addr.sun_path) - 1] = <span class="charliteral">'\0'</span>; -<a name="l00357"></a>00357 <span class="keywordflow">do</span> { -<a name="l00358"></a>00358 ret =<a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the..."> ::connect</a>(fd, (<span class="keyword">const</span> sockaddr *) &amp;addr, <span class="keyword">sizeof</span>(addr)); -<a name="l00359"></a>00359 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR); -<a name="l00360"></a>00360 <span class="keywordflow">if</span> (ret == -1) { -<a name="l00361"></a>00361 <span class="keywordtype">int</span> e = errno; -<a name="l00362"></a>00362 <span class="keywordtype">string</span> message(<span class="stringliteral">"Cannot connect to Unix socket '"</span>); -<a name="l00363"></a>00363 message.append(listenSocketName); -<a name="l00364"></a>00364 message.append(<span class="stringliteral">"' on the abstract namespace"</span>); -<a name="l00365"></a>00365 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(message, e); -<a name="l00366"></a>00366 } -<a name="l00367"></a>00367 -<a name="l00368"></a>00368 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> StandardSession(pid, closeCallback, fd)); -<a name="l00369"></a>00369 } -<a name="l00370"></a>00370 -<a name="l00371"></a>00371 <span class="keywordtype">void</span> detach() { -<a name="l00372"></a>00372 close(ownerPipe); -<a name="l00373"></a>00373 ownerPipe = -1; -<a name="l00374"></a>00374 } -<a name="l00375"></a>00375 }; -<a name="l00376"></a>00376 <span class="comment"></span> -<a name="l00377"></a>00377 <span class="comment">/** Convenient alias for Application smart pointer. */</span> -<a name="l00378"></a>00378 <span class="keyword">typedef</span> shared_ptr&lt;Application&gt; ApplicationPtr; -<a name="l00379"></a>00379 -<a name="l00380"></a>00380 } <span class="comment">// namespace Passenger</span> -<a name="l00381"></a>00381 -<a name="l00382"></a>00382 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_APPLICATION_H_ */</span> -</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Wed May 7 20:28:18 2008 for Passenger by&nbsp; +<a name="l00274"></a>00274 }; +<a name="l00275"></a>00275 +<a name="l00276"></a>00276 <span class="keywordtype">string</span> appRoot; +<a name="l00277"></a>00277 pid_t pid; +<a name="l00278"></a>00278 <span class="keywordtype">string</span> listenSocketName; +<a name="l00279"></a>00279 <span class="keywordtype">bool</span> usingAbstractNamespace; +<a name="l00280"></a>00280 <span class="keywordtype">int</span> ownerPipe; +<a name="l00281"></a>00281 +<a name="l00282"></a>00282 <span class="keyword">public</span>:<span class="comment"></span> +<a name="l00283"></a>00283 <span class="comment"> /**</span> +<a name="l00284"></a>00284 <span class="comment"> * Construct a new Application object.</span> +<a name="l00285"></a>00285 <span class="comment"> *</span> +<a name="l00286"></a>00286 <span class="comment"> * @param theAppRoot The application root of an application. In case of a Rails application,</span> +<a name="l00287"></a>00287 <span class="comment"> * this is the folder that contains 'app/', 'public/', 'config/', etc.</span> +<a name="l00288"></a>00288 <span class="comment"> * This must be a valid directory, but the path does not have to be absolute.</span> +<a name="l00289"></a>00289 <span class="comment"> * @param pid The process ID of this application instance.</span> +<a name="l00290"></a>00290 <span class="comment"> * @param listenSocketName The name of the listener socket of this application instance.</span> +<a name="l00291"></a>00291 <span class="comment"> * @param usingAbstractNamespace Whether &lt;tt&gt;listenSocketName&lt;/tt&gt; refers to a Unix</span> +<a name="l00292"></a>00292 <span class="comment"> * socket on the abstract namespace. Note that listenSocketName must not</span> +<a name="l00293"></a>00293 <span class="comment"> * contain the leading null byte, even if it's an abstract namespace socket.</span> +<a name="l00294"></a>00294 <span class="comment"> * @param ownerPipe The owner pipe of this application instance.</span> +<a name="l00295"></a>00295 <span class="comment"> * @post getAppRoot() == theAppRoot &amp;&amp; getPid() == pid</span> +<a name="l00296"></a>00296 <span class="comment"> */</span> +<a name="l00297"></a><a class="code" href="classPassenger_1_1Application.html#163509167eef118470b72661ac8acd5d">00297</a> <a class="code" href="classPassenger_1_1Application.html#163509167eef118470b72661ac8acd5d" title="Construct a new Application object.">Application</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;theAppRoot, pid_t pid, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;listenSocketName, +<a name="l00298"></a>00298 <span class="keywordtype">bool</span> usingAbstractNamespace, <span class="keywordtype">int</span> ownerPipe) { +<a name="l00299"></a>00299 appRoot = theAppRoot; +<a name="l00300"></a>00300 this-&gt;pid = pid; +<a name="l00301"></a>00301 this-&gt;listenSocketName = listenSocketName; +<a name="l00302"></a>00302 this-&gt;usingAbstractNamespace = usingAbstractNamespace; +<a name="l00303"></a>00303 this-&gt;ownerPipe = ownerPipe; +<a name="l00304"></a>00304 P_TRACE(3, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": created."</span>); +<a name="l00305"></a>00305 } +<a name="l00306"></a>00306 +<a name="l00307"></a>00307 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails or Rack application instance.">Application</a>() { +<a name="l00308"></a>00308 <span class="keywordtype">int</span> ret; +<a name="l00309"></a>00309 +<a name="l00310"></a>00310 <span class="keywordflow">if</span> (ownerPipe != -1) { +<a name="l00311"></a>00311 <span class="keywordflow">do</span> { +<a name="l00312"></a>00312 ret = close(ownerPipe); +<a name="l00313"></a>00313 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR); +<a name="l00314"></a>00314 } +<a name="l00315"></a>00315 <span class="keywordflow">if</span> (!usingAbstractNamespace) { +<a name="l00316"></a>00316 <span class="keywordflow">do</span> { +<a name="l00317"></a>00317 ret = unlink(listenSocketName.c_str()); +<a name="l00318"></a>00318 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR); +<a name="l00319"></a>00319 } +<a name="l00320"></a>00320 P_TRACE(3, <span class="stringliteral">"Application "</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">": destroyed."</span>); +<a name="l00321"></a>00321 } +<a name="l00322"></a>00322 <span class="comment"></span> +<a name="l00323"></a>00323 <span class="comment"> /**</span> +<a name="l00324"></a>00324 <span class="comment"> * Returns the application root for this application. See the constructor</span> +<a name="l00325"></a>00325 <span class="comment"> * for information about the application root.</span> +<a name="l00326"></a>00326 <span class="comment"> */</span> +<a name="l00327"></a><a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56">00327</a> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this application.">getAppRoot</a>()<span class="keyword"> const </span>{ +<a name="l00328"></a>00328 <span class="keywordflow">return</span> appRoot; +<a name="l00329"></a>00329 } +<a name="l00330"></a>00330 <span class="comment"></span> +<a name="l00331"></a>00331 <span class="comment"> /**</span> +<a name="l00332"></a>00332 <span class="comment"> * Returns the process ID of this application instance.</span> +<a name="l00333"></a>00333 <span class="comment"> */</span> +<a name="l00334"></a><a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02">00334</a> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>()<span class="keyword"> const </span>{ +<a name="l00335"></a>00335 <span class="keywordflow">return</span> pid; +<a name="l00336"></a>00336 } +<a name="l00337"></a>00337 <span class="comment"></span> +<a name="l00338"></a>00338 <span class="comment"> /**</span> +<a name="l00339"></a>00339 <span class="comment"> * Connect to this application instance with the purpose of sending</span> +<a name="l00340"></a>00340 <span class="comment"> * a request to the application. Once connected, a new session will</span> +<a name="l00341"></a>00341 <span class="comment"> * be opened. This session represents the life time of a single</span> +<a name="l00342"></a>00342 <span class="comment"> * request/response pair, and can be used to send the request</span> +<a name="l00343"></a>00343 <span class="comment"> * data to the application instance, as well as receiving the response</span> +<a name="l00344"></a>00344 <span class="comment"> * data.</span> +<a name="l00345"></a>00345 <span class="comment"> *</span> +<a name="l00346"></a>00346 <span class="comment"> * The use of connect() is demonstrated in the following example.</span> +<a name="l00347"></a>00347 <span class="comment"> * @code</span> +<a name="l00348"></a>00348 <span class="comment"> * // Connect to the application and get the newly opened session.</span> +<a name="l00349"></a>00349 <span class="comment"> * Application::SessionPtr session(app-&gt;connect("/home/webapps/foo"));</span> +<a name="l00350"></a>00350 <span class="comment"> * </span> +<a name="l00351"></a>00351 <span class="comment"> * // Send the request headers and request body data.</span> +<a name="l00352"></a>00352 <span class="comment"> * session-&gt;sendHeaders(...);</span> +<a name="l00353"></a>00353 <span class="comment"> * session-&gt;sendBodyBlock(...);</span> +<a name="l00354"></a>00354 <span class="comment"> * // Done sending data, so we close the writer channel.</span> +<a name="l00355"></a>00355 <span class="comment"> * session-&gt;closeWriter();</span> +<a name="l00356"></a>00356 <span class="comment"> *</span> +<a name="l00357"></a>00357 <span class="comment"> * // Now read the HTTP response.</span> +<a name="l00358"></a>00358 <span class="comment"> * string responseData = readAllDataFromSocket(session-&gt;getReader());</span> +<a name="l00359"></a>00359 <span class="comment"> * // Done reading data, so we close the reader channel.</span> +<a name="l00360"></a>00360 <span class="comment"> * session-&gt;closeReader();</span> +<a name="l00361"></a>00361 <span class="comment"> *</span> +<a name="l00362"></a>00362 <span class="comment"> * // This session has now finished, so we close the session by resetting</span> +<a name="l00363"></a>00363 <span class="comment"> * // the smart pointer to NULL (thereby destroying the Session object).</span> +<a name="l00364"></a>00364 <span class="comment"> * session.reset();</span> +<a name="l00365"></a>00365 <span class="comment"> *</span> +<a name="l00366"></a>00366 <span class="comment"> * // We can connect to an Application multiple times. Just make sure</span> +<a name="l00367"></a>00367 <span class="comment"> * // the previous session is closed.</span> +<a name="l00368"></a>00368 <span class="comment"> * session = app-&gt;connect("/home/webapps/bar")</span> +<a name="l00369"></a>00369 <span class="comment"> * @endcode</span> +<a name="l00370"></a>00370 <span class="comment"> *</span> +<a name="l00371"></a>00371 <span class="comment"> * Note that a RoR application instance can only process one</span> +<a name="l00372"></a>00372 <span class="comment"> * request at the same time, and thus only one session at the same time.</span> +<a name="l00373"></a>00373 <span class="comment"> * It's unspecified whether Rack applications can handle multiple simultanous sessions.</span> +<a name="l00374"></a>00374 <span class="comment"> *</span> +<a name="l00375"></a>00375 <span class="comment"> * You &lt;b&gt;must&lt;/b&gt; close a session when you no longer need if. If you</span> +<a name="l00376"></a>00376 <span class="comment"> * call connect() without having properly closed a previous session,</span> +<a name="l00377"></a>00377 <span class="comment"> * you might cause a deadlock because the application instance may be</span> +<a name="l00378"></a>00378 <span class="comment"> * waiting for you to close the previous session.</span> +<a name="l00379"></a>00379 <span class="comment"> *</span> +<a name="l00380"></a>00380 <span class="comment"> * @return A smart pointer to a Session object, which represents the created session.</span> +<a name="l00381"></a>00381 <span class="comment"> * @param closeCallback A function which will be called when the session has been closed.</span> +<a name="l00382"></a>00382 <span class="comment"> * @post this-&gt;getSessions() == old-&gt;getSessions() + 1</span> +<a name="l00383"></a>00383 <span class="comment"> * @throws SystemException Something went wrong during the connection process.</span> +<a name="l00384"></a>00384 <span class="comment"> * @throws IOException Something went wrong during the connection process.</span> +<a name="l00385"></a>00385 <span class="comment"> */</span> +<a name="l00386"></a><a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379">00386</a> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> <a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the...">connect</a>(<span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback)<span class="keyword"> const </span>{ +<a name="l00387"></a>00387 <span class="keywordtype">int</span> fd, ret; +<a name="l00388"></a>00388 +<a name="l00389"></a>00389 <span class="keywordflow">do</span> { +<a name="l00390"></a>00390 fd = socket(PF_UNIX, SOCK_STREAM, 0); +<a name="l00391"></a>00391 } <span class="keywordflow">while</span> (fd == -1 &amp;&amp; errno == EINTR); +<a name="l00392"></a>00392 <span class="keywordflow">if</span> (fd == -1) { +<a name="l00393"></a>00393 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot create a new unconnected Unix socket"</span>, errno); +<a name="l00394"></a>00394 } +<a name="l00395"></a>00395 +<a name="l00396"></a>00396 <span class="keyword">struct </span>sockaddr_un addr; +<a name="l00397"></a>00397 addr.sun_family = AF_UNIX; +<a name="l00398"></a>00398 <span class="keywordflow">if</span> (usingAbstractNamespace) { +<a name="l00399"></a>00399 strncpy(addr.sun_path + 1, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path) - 1); +<a name="l00400"></a>00400 addr.sun_path[0] = <span class="charliteral">'\0'</span>; +<a name="l00401"></a>00401 } <span class="keywordflow">else</span> { +<a name="l00402"></a>00402 strncpy(addr.sun_path, listenSocketName.c_str(), <span class="keyword">sizeof</span>(addr.sun_path)); +<a name="l00403"></a>00403 } +<a name="l00404"></a>00404 addr.sun_path[<span class="keyword">sizeof</span>(addr.sun_path) - 1] = <span class="charliteral">'\0'</span>; +<a name="l00405"></a>00405 <span class="keywordflow">do</span> { +<a name="l00406"></a>00406 ret =<a class="code" href="classPassenger_1_1Application.html#34636f796ff3924ad5ec142aaa581379" title="Connect to this application instance with the purpose of sending a request to the..."> ::connect</a>(fd, (<span class="keyword">const</span> sockaddr *) &amp;addr, <span class="keyword">sizeof</span>(addr)); +<a name="l00407"></a>00407 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR); +<a name="l00408"></a>00408 <span class="keywordflow">if</span> (ret == -1) { +<a name="l00409"></a>00409 <span class="keywordtype">int</span> e = errno; +<a name="l00410"></a>00410 <span class="keywordtype">string</span> message(<span class="stringliteral">"Cannot connect to Unix socket '"</span>); +<a name="l00411"></a>00411 message.append(listenSocketName); +<a name="l00412"></a>00412 message.append(<span class="stringliteral">"' on the abstract namespace"</span>); +<a name="l00413"></a>00413 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(message, e); +<a name="l00414"></a>00414 } +<a name="l00415"></a>00415 +<a name="l00416"></a>00416 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> StandardSession(pid, closeCallback, fd)); +<a name="l00417"></a>00417 } +<a name="l00418"></a>00418 }; +<a name="l00419"></a>00419 <span class="comment"></span> +<a name="l00420"></a>00420 <span class="comment">/** Convenient alias for Application smart pointer. */</span> +<a name="l00421"></a><a class="code" href="namespacePassenger.html#6a15fd5e8765802a0b8b077e15297e18">00421</a> <span class="keyword">typedef</span> shared_ptr&lt;Application&gt; <a class="code" href="namespacePassenger.html#6a15fd5e8765802a0b8b077e15297e18" title="Convenient alias for Application smart pointer.">ApplicationPtr</a>; +<a name="l00422"></a>00422 +<a name="l00423"></a>00423 } <span class="comment">// namespace Passenger</span> +<a name="l00424"></a>00424 +<a name="l00425"></a>00425 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_APPLICATION_H_ */</span> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 24 14:03:42 2008 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.3 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> </body> </html>