RubyGems - passenger - Versions diffs - 3.0.4 → 3.0.5 - Mend

passenger 3.0.4 → 3.0.5

Potentially problematic release.

This version of passenger might be problematic. Click here for more details.

Files changed (571) hide show

data/doc/cxxapi/ServerInstanceDir_8h_source.html ADDED

@@ -0,0 +1,378 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: ServerInstanceDir.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<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>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>ServerInstanceDir.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) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; 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"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_SERVER_INSTANCE_DIR_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SERVER_INSTANCE_DIR_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/noncopyable.hpp&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;oxt/backtrace.hpp&gt;</span>
+<a name="l00031"></a>00031
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;dirent.h&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;pwd.h&gt;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;grp.h&gt;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;cstdlib&gt;</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include &lt;cstring&gt;</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00040"></a>00040
+<a name="l00041"></a>00041 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
+<a name="l00042"></a>00042 <span class="preprocessor">#include &quot;Utils.h&quot;</span>
+<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;Utils/StrIntUtils.h&quot;</span>
+<a name="l00044"></a>00044
+<a name="l00045"></a>00045 <span class="keyword">namespace </span>Passenger {
+<a name="l00046"></a>00046
+<a name="l00047"></a>00047 <span class="keyword">using namespace </span>std;
+<a name="l00048"></a>00048 <span class="keyword">using namespace </span>boost;
+<a name="l00049"></a>00049
+<a name="l00050"></a>00050 <span class="keyword">class </span>ServerInstanceDir: <span class="keyword">public</span> noncopyable {
+<a name="l00051"></a>00051 <span class="keyword">public</span>:
+<a name="l00052"></a>00052         <span class="comment">// Don&#39;t forget to update lib/phusion_passenger/admin_tools/server_instance.rb too.</span>
+<a name="l00053"></a>00053         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> DIR_STRUCTURE_MAJOR_VERSION = 1;
+<a name="l00054"></a>00054         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> DIR_STRUCTURE_MINOR_VERSION = 0;
+<a name="l00055"></a>00055         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> GENERATION_STRUCTURE_MAJOR_VERSION = 1;
+<a name="l00056"></a>00056         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> GENERATION_STRUCTURE_MINOR_VERSION = 0;
+<a name="l00057"></a>00057
+<a name="l00058"></a>00058         <span class="keyword">class </span>Generation: <span class="keyword">public</span> noncopyable {
+<a name="l00059"></a>00059         <span class="keyword">private</span>:
+<a name="l00060"></a>00060                 <span class="keyword">friend</span> <span class="keyword">class </span>ServerInstanceDir;
+<a name="l00061"></a>00061
+<a name="l00062"></a>00062                 <span class="keywordtype">string</span> path;
+<a name="l00063"></a>00063                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number;
+<a name="l00064"></a>00064                 <span class="keywordtype">bool</span> owner;
+<a name="l00065"></a>00065
+<a name="l00066"></a>00066                 Generation(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;serverInstanceDir, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number) {
+<a name="l00067"></a>00067                         path = serverInstanceDir + <span class="stringliteral">&quot;/generation-&quot;</span> + toString(number);
+<a name="l00068"></a>00068                         this-&gt;number = number;
+<a name="l00069"></a>00069                         owner = <span class="keyword">false</span>;
+<a name="l00070"></a>00070                 }
+<a name="l00071"></a>00071
+<a name="l00072"></a>00072                 <span class="keywordtype">void</span> create(<span class="keywordtype">bool</span> userSwitching, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;defaultUser,
+<a name="l00073"></a>00073                             <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;defaultGroup, uid_t webServerWorkerUid,
+<a name="l00074"></a>00074                             gid_t webServerWorkerGid)
+<a name="l00075"></a>00075                 {
+<a name="l00076"></a>00076                         TRACE_POINT();
+<a name="l00077"></a>00077                         <span class="keywordtype">bool</span> runningAsRoot = geteuid() == 0;
+<a name="l00078"></a>00078                         <span class="keyword">struct </span>passwd *defaultUserEntry;
+<a name="l00079"></a>00079                         <span class="keyword">struct </span>group  *defaultGroupEntry;
+<a name="l00080"></a>00080                         uid_t defaultUid;
+<a name="l00081"></a>00081                         gid_t defaultGid;
+<a name="l00082"></a>00082
+<a name="l00083"></a>00083                         defaultUserEntry = getpwnam(defaultUser.c_str());
+<a name="l00084"></a>00084                         <span class="keywordflow">if</span> (defaultUserEntry == NULL) {
+<a name="l00085"></a>00085                                 <span class="keywordflow">throw</span> NonExistentUserException(<span class="stringliteral">&quot;Default user &#39;&quot;</span> + defaultUser +
+<a name="l00086"></a>00086                                         <span class="stringliteral">&quot;&#39; does not exist.&quot;</span>);
+<a name="l00087"></a>00087                         }
+<a name="l00088"></a>00088                         defaultUid = defaultUserEntry-&gt;pw_uid;
+<a name="l00089"></a>00089                         defaultGroupEntry = getgrnam(defaultGroup.c_str());
+<a name="l00090"></a>00090                         <span class="keywordflow">if</span> (defaultGroupEntry == NULL) {
+<a name="l00091"></a>00091                                 <span class="keywordflow">throw</span> NonExistentGroupException(<span class="stringliteral">&quot;Default group &#39;&quot;</span> + defaultGroup +
+<a name="l00092"></a>00092                                         <span class="stringliteral">&quot;&#39; does not exist.&quot;</span>);
+<a name="l00093"></a>00093                         }
+<a name="l00094"></a>00094                         defaultGid = defaultGroupEntry-&gt;gr_gid;
+<a name="l00095"></a>00095
+<a name="l00096"></a>00096                         <span class="comment">/* We set a very tight permission here: no read or write access for</span>
+<a name="l00097"></a>00097 <span class="comment">                         * anybody except the owner. The individual files and subdirectories</span>
+<a name="l00098"></a>00098 <span class="comment">                         * decide for themselves whether they&#39;re readable by anybody.</span>
+<a name="l00099"></a>00099 <span class="comment">                         */</span>
+<a name="l00100"></a>00100                         <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path, <span class="stringliteral">&quot;u=rwxs,g=x,o=x&quot;</span>);
+<a name="l00101"></a>00101
+<a name="l00102"></a>00102                         <span class="comment">/* Write structure version file. */</span>
+<a name="l00103"></a>00103                         <span class="keywordtype">string</span> structureVersionFile = path + <span class="stringliteral">&quot;/structure_version.txt&quot;</span>;
+<a name="l00104"></a>00104                         <a class="code" href="group__Support.html#ga6f414070373465da2e12947463f69953" title="Create the given file with the given contents, permissions and ownership.">createFile</a>(structureVersionFile,
+<a name="l00105"></a>00105                                 toString(GENERATION_STRUCTURE_MAJOR_VERSION) + <span class="stringliteral">&quot;.&quot;</span> +
+<a name="l00106"></a>00106                                 toString(GENERATION_STRUCTURE_MINOR_VERSION),
+<a name="l00107"></a>00107                                 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
+<a name="l00108"></a>00108
+<a name="l00109"></a>00109
+<a name="l00110"></a>00110                         <span class="comment">/* We want the upload buffer directory to be only writable by the web</span>
+<a name="l00111"></a>00111 <span class="comment">                         * server&#39;s worker processs. Other users may not have any access to this</span>
+<a name="l00112"></a>00112 <span class="comment">                         * directory.</span>
+<a name="l00113"></a>00113 <span class="comment">                         */</span>
+<a name="l00114"></a>00114                         <span class="keywordflow">if</span> (runningAsRoot) {
+<a name="l00115"></a>00115                                 <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/buffered_uploads&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=,o=&quot;</span>,
+<a name="l00116"></a>00116                                         webServerWorkerUid, webServerWorkerGid);
+<a name="l00117"></a>00117                         } <span class="keywordflow">else</span> {
+<a name="l00118"></a>00118                                 <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/buffered_uploads&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=,o=&quot;</span>);
+<a name="l00119"></a>00119                         }
+<a name="l00120"></a>00120
+<a name="l00121"></a>00121                         <span class="comment">/* The web server must be able to directly connect to a backend. */</span>
+<a name="l00122"></a>00122                         <span class="keywordflow">if</span> (runningAsRoot) {
+<a name="l00123"></a>00123                                 <span class="keywordflow">if</span> (userSwitching) {
+<a name="l00124"></a>00124                                         <span class="comment">/* Each backend process may be running as a different user,</span>
+<a name="l00125"></a>00125 <span class="comment">                                         * so the backends subdirectory must be world-writable.</span>
+<a name="l00126"></a>00126 <span class="comment">                                         * However we don&#39;t want everybody to be able to know the</span>
+<a name="l00127"></a>00127 <span class="comment">                                         * sockets&#39; filenames, so the directory is not readable.</span>
+<a name="l00128"></a>00128 <span class="comment">                                         */</span>
+<a name="l00129"></a>00129                                         <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/backends&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=wx,o=wx&quot;</span>);
+<a name="l00130"></a>00130                                 } <span class="keywordflow">else</span> {
+<a name="l00131"></a>00131                                         <span class="comment">/* All backend processes are running as defaultUser/defaultGroup,</span>
+<a name="l00132"></a>00132 <span class="comment">                                         * so make defaultUser/defaultGroup the owner and group of the</span>
+<a name="l00133"></a>00133 <span class="comment">                                         * subdirecory.</span>
+<a name="l00134"></a>00134 <span class="comment">                                         *</span>
+<a name="l00135"></a>00135 <span class="comment">                                         * The directory is not readable as a security precaution:</span>
+<a name="l00136"></a>00136 <span class="comment">                                         * nobody should be able to know the sockets&#39; filenames without</span>
+<a name="l00137"></a>00137 <span class="comment">                                         * having access to the application pool.</span>
+<a name="l00138"></a>00138 <span class="comment">                                         */</span>
+<a name="l00139"></a>00139                                         <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/backends&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=x,o=x&quot;</span>, defaultUid, defaultGid);
+<a name="l00140"></a>00140                                 }
+<a name="l00141"></a>00141                         } <span class="keywordflow">else</span> {
+<a name="l00142"></a>00142                                 <span class="comment">/* All backend processes are running as the same user as the web server,</span>
+<a name="l00143"></a>00143 <span class="comment">                                 * so only allow access for this user.</span>
+<a name="l00144"></a>00144 <span class="comment">                                 */</span>
+<a name="l00145"></a>00145                                 <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/backends&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=,o=&quot;</span>);
+<a name="l00146"></a>00146                         }
+<a name="l00147"></a>00147
+<a name="l00148"></a>00148                         <span class="comment">/* The helper server (containing the application pool) must be able to access</span>
+<a name="l00149"></a>00149 <span class="comment">                         * the spawn server&#39;s socket.</span>
+<a name="l00150"></a>00150 <span class="comment">                         */</span>
+<a name="l00151"></a>00151                         <span class="keywordflow">if</span> (runningAsRoot) {
+<a name="l00152"></a>00152                                 <span class="keywordflow">if</span> (userSwitching) {
+<a name="l00153"></a>00153                                         <span class="comment">/* Both the helper server and the spawn server are</span>
+<a name="l00154"></a>00154 <span class="comment">                                         * running as root.</span>
+<a name="l00155"></a>00155 <span class="comment">                                         */</span>
+<a name="l00156"></a>00156                                         <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/spawn-server&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=,o=&quot;</span>);
+<a name="l00157"></a>00157                                 } <span class="keywordflow">else</span> {
+<a name="l00158"></a>00158                                         <span class="comment">/* Both the helper server and the spawn server are</span>
+<a name="l00159"></a>00159 <span class="comment">                                         * running as defaultUser/defaultGroup.</span>
+<a name="l00160"></a>00160 <span class="comment">                                         */</span>
+<a name="l00161"></a>00161                                         <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/spawn-server&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=,o=&quot;</span>,
+<a name="l00162"></a>00162                                                 defaultUid, defaultGid);
+<a name="l00163"></a>00163                                 }
+<a name="l00164"></a>00164                         } <span class="keywordflow">else</span> {
+<a name="l00165"></a>00165                                 <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">&quot;/spawn-server&quot;</span>, <span class="stringliteral">&quot;u=rwxs,g=,o=&quot;</span>);
+<a name="l00166"></a>00166                         }
+<a name="l00167"></a>00167
+<a name="l00168"></a>00168                         owner = <span class="keyword">true</span>;
+<a name="l00169"></a>00169                 }
+<a name="l00170"></a>00170
+<a name="l00171"></a>00171         <span class="keyword">public</span>:
+<a name="l00172"></a>00172                 ~Generation() {
+<a name="l00173"></a>00173                         <span class="keywordflow">if</span> (owner) {
+<a name="l00174"></a>00174                                 <a class="code" href="namespacePassenger.html#a8422d210cbd2f62d21254415b5a7f747" title="Remove an entire directory tree recursively.">removeDirTree</a>(path);
+<a name="l00175"></a>00175                         }
+<a name="l00176"></a>00176                 }
+<a name="l00177"></a>00177
+<a name="l00178"></a>00178                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getNumber()<span class="keyword"> const </span>{
+<a name="l00179"></a>00179                         <span class="keywordflow">return</span> number;
+<a name="l00180"></a>00180                 }
+<a name="l00181"></a>00181
+<a name="l00182"></a>00182                 <span class="keywordtype">string</span> getPath()<span class="keyword"> const </span>{
+<a name="l00183"></a>00183                         <span class="keywordflow">return</span> path;
+<a name="l00184"></a>00184                 }
+<a name="l00185"></a>00185
+<a name="l00186"></a>00186                 <span class="keywordtype">void</span> detach() {
+<a name="l00187"></a>00187                         owner = <span class="keyword">false</span>;
+<a name="l00188"></a>00188                 }
+<a name="l00189"></a>00189         };
+<a name="l00190"></a>00190
+<a name="l00191"></a>00191         <span class="keyword">typedef</span> shared_ptr&lt;Generation&gt; GenerationPtr;
+<a name="l00192"></a>00192
+<a name="l00193"></a>00193 <span class="keyword">private</span>:
+<a name="l00194"></a>00194         <span class="keywordtype">string</span> path;
+<a name="l00195"></a>00195         <span class="keywordtype">bool</span> owner;
+<a name="l00196"></a>00196
+<a name="l00197"></a>00197         <span class="keyword">friend</span> <span class="keyword">class </span>Generation;
+<a name="l00198"></a>00198
+<a name="l00199"></a>00199         <span class="keywordtype">void</span> initialize(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;path, <span class="keywordtype">bool</span> owner) {
+<a name="l00200"></a>00200                 TRACE_POINT();
+<a name="l00201"></a>00201                 this-&gt;path  = path;
+<a name="l00202"></a>00202                 this-&gt;owner = owner;
+<a name="l00203"></a>00203
+<a name="l00204"></a>00204                 <span class="comment">/* Create the server instance directory. We only need to write to this</span>
+<a name="l00205"></a>00205 <span class="comment">                 * directory for these reasons:</span>
+<a name="l00206"></a>00206 <span class="comment">                 * 1. Initial population of structure files (structure_version.txt, instance.pid).</span>
+<a name="l00207"></a>00207 <span class="comment">                 * 2. Creating/removing a generation directory.</span>
+<a name="l00208"></a>00208 <span class="comment">                 * 3. Removing the entire server instance directory (after all</span>
+<a name="l00209"></a>00209 <span class="comment">                 *    generations are removed).</span>
+<a name="l00210"></a>00210 <span class="comment">                 *</span>
+<a name="l00211"></a>00211 <span class="comment">                 * 1 and 2 are done by the helper server during initialization and before lowering</span>
+<a name="l00212"></a>00212 <span class="comment">                 * privilege. 3 is done during helper server shutdown by a cleanup process that&#39;s</span>
+<a name="l00213"></a>00213 <span class="comment">                 * running as the same user the helper server was running as before privilege</span>
+<a name="l00214"></a>00214 <span class="comment">                 * lowering.</span>
+<a name="l00215"></a>00215 <span class="comment">                 * Therefore, we make the directory only writable by the user the helper server</span>
+<a name="l00216"></a>00216 <span class="comment">                 * was running as before privilege is lowered. Everybody else has read and execute</span>
+<a name="l00217"></a>00217 <span class="comment">                 * rights though, because we want admin tools to be able to list the available</span>
+<a name="l00218"></a>00218 <span class="comment">                 * generations no matter what user they&#39;re running as.</span>
+<a name="l00219"></a>00219 <span class="comment">                 */</span>
+<a name="l00220"></a>00220                 <a class="code" href="namespacePassenger.html#a448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path, <span class="stringliteral">&quot;u=rwxs,g=rx,o=rx&quot;</span>);
+<a name="l00221"></a>00221         }
+<a name="l00222"></a>00222
+<a name="l00223"></a>00223         <span class="keywordtype">bool</span> isDirectory(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;dir, <span class="keyword">struct</span> dirent *entry)<span class="keyword"> const </span>{
+<a name="l00224"></a>00224 <span class="preprocessor">                #ifdef DT_DIR</span>
+<a name="l00225"></a>00225 <span class="preprocessor"></span>                        <span class="keywordflow">if</span> (entry-&gt;d_type == DT_DIR) {
+<a name="l00226"></a>00226                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00227"></a>00227                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (entry-&gt;d_type != DT_UNKNOWN) {
+<a name="l00228"></a>00228                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00229"></a>00229                         }
+<a name="l00230"></a>00230                         <span class="comment">// If DT_UNKNOWN, use normal check.</span>
+<a name="l00231"></a>00231 <span class="preprocessor">                #endif</span>
+<a name="l00232"></a>00232 <span class="preprocessor"></span>                <span class="keywordtype">string</span> path = dir;
+<a name="l00233"></a>00233                 path.append(<span class="stringliteral">&quot;/&quot;</span>);
+<a name="l00234"></a>00234                 path.append(entry-&gt;d_name);
+<a name="l00235"></a>00235                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga15298b031377d3ecb80295bd5b1a8180" title="Check whether &amp;#39;filename&amp;#39; exists and what kind of file it is.">getFileType</a>(path) == <a class="code" href="namespacePassenger.html#a14174b712df6046cb823cde43d7ef07dabb09dbba1071b4770913363db2462eee" title="A directory.">FT_DIRECTORY</a>;
+<a name="l00236"></a>00236         }
+<a name="l00237"></a>00237
+<a name="l00238"></a>00238 <span class="keyword">public</span>:
+<a name="l00239"></a>00239         ServerInstanceDir(pid_t webServerPid, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;parentDir = <span class="stringliteral">&quot;&quot;</span>, <span class="keywordtype">bool</span> owner = <span class="keyword">true</span>) {
+<a name="l00240"></a>00240                 <span class="keywordtype">string</span> theParentDir;
+<a name="l00241"></a>00241
+<a name="l00242"></a>00242                 <span class="keywordflow">if</span> (parentDir.empty()) {
+<a name="l00243"></a>00243                         theParentDir = <a class="code" href="group__Support.html#ga68f4105c5a8e510520b5ea3eecb66213" title="Return the path name for the directory in which the system stores general temporary...">getSystemTempDir</a>();
+<a name="l00244"></a>00244                 } <span class="keywordflow">else</span> {
+<a name="l00245"></a>00245                         theParentDir = parentDir;
+<a name="l00246"></a>00246                 }
+<a name="l00247"></a>00247
+<a name="l00248"></a>00248                 <span class="comment">/* We embed the super structure version in the server instance directory name</span>
+<a name="l00249"></a>00249 <span class="comment">                 * because it&#39;s possible to upgrade Phusion Passenger without changing the</span>
+<a name="l00250"></a>00250 <span class="comment">                 * web server&#39;s PID. This way each incompatible upgrade will use its own</span>
+<a name="l00251"></a>00251 <span class="comment">                 * server instance directory.</span>
+<a name="l00252"></a>00252 <span class="comment">                 */</span>
+<a name="l00253"></a>00253                 initialize(theParentDir + <span class="stringliteral">&quot;/passenger.&quot;</span> +
+<a name="l00254"></a>00254                         toString(DIR_STRUCTURE_MAJOR_VERSION) + <span class="stringliteral">&quot;.&quot;</span> +
+<a name="l00255"></a>00255                         toString(DIR_STRUCTURE_MINOR_VERSION) + <span class="stringliteral">&quot;.&quot;</span> +
+<a name="l00256"></a>00256                         toString&lt;unsigned long long&gt;(webServerPid),
+<a name="l00257"></a>00257                         owner);
+<a name="l00258"></a>00258
+<a name="l00259"></a>00259         }
+<a name="l00260"></a>00260
+<a name="l00261"></a>00261         ServerInstanceDir(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;path, <span class="keywordtype">bool</span> owner = <span class="keyword">true</span>) {
+<a name="l00262"></a>00262                 initialize(path, owner);
+<a name="l00263"></a>00263         }
+<a name="l00264"></a>00264
+<a name="l00265"></a>00265         ~ServerInstanceDir() {
+<a name="l00266"></a>00266                 <span class="keywordflow">if</span> (owner) {
+<a name="l00267"></a>00267                         GenerationPtr newestGeneration;
+<a name="l00268"></a>00268                         <span class="keywordflow">try</span> {
+<a name="l00269"></a>00269                                 newestGeneration = getNewestGeneration();
+<a name="l00270"></a>00270                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> FileSystemException &amp;e) {
+<a name="l00271"></a>00271                                 <span class="keywordflow">if</span> (e.code() == ENOENT) {
+<a name="l00272"></a>00272                                         <span class="keywordflow">return</span>;
+<a name="l00273"></a>00273                                 } <span class="keywordflow">else</span> {
+<a name="l00274"></a>00274                                         <span class="keywordflow">throw</span>;
+<a name="l00275"></a>00275                                 }
+<a name="l00276"></a>00276                         }
+<a name="l00277"></a>00277                         <span class="keywordflow">if</span> (newestGeneration == NULL) {
+<a name="l00278"></a>00278                                 <a class="code" href="namespacePassenger.html#a8422d210cbd2f62d21254415b5a7f747" title="Remove an entire directory tree recursively.">removeDirTree</a>(path);
+<a name="l00279"></a>00279                         }
+<a name="l00280"></a>00280                 }
+<a name="l00281"></a>00281         }
+<a name="l00282"></a>00282
+<a name="l00283"></a>00283         <span class="keywordtype">string</span> getPath()<span class="keyword"> const </span>{
+<a name="l00284"></a>00284                 <span class="keywordflow">return</span> path;
+<a name="l00285"></a>00285         }
+<a name="l00286"></a>00286
+<a name="l00287"></a>00287         <span class="keywordtype">void</span> detach() {
+<a name="l00288"></a>00288                 owner = <span class="keyword">false</span>;
+<a name="l00289"></a>00289         }
+<a name="l00290"></a>00290
+<a name="l00291"></a>00291         GenerationPtr newGeneration(<span class="keywordtype">bool</span> userSwitching, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;defaultUser,
+<a name="l00292"></a>00292                                     <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;defaultGroup, uid_t webServerWorkerUid,
+<a name="l00293"></a>00293                                     gid_t webServerWorkerGid)
+<a name="l00294"></a>00294         {
+<a name="l00295"></a>00295                 GenerationPtr newestGeneration = getNewestGeneration();
+<a name="l00296"></a>00296                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> newNumber;
+<a name="l00297"></a>00297                 <span class="keywordflow">if</span> (newestGeneration != NULL) {
+<a name="l00298"></a>00298                         newNumber = newestGeneration-&gt;getNumber() + 1;
+<a name="l00299"></a>00299                 } <span class="keywordflow">else</span> {
+<a name="l00300"></a>00300                         newNumber = 0;
+<a name="l00301"></a>00301                 }
+<a name="l00302"></a>00302
+<a name="l00303"></a>00303                 GenerationPtr generation(<span class="keyword">new</span> Generation(path, newNumber));
+<a name="l00304"></a>00304                 generation-&gt;create(userSwitching, defaultUser, defaultGroup,
+<a name="l00305"></a>00305                         webServerWorkerUid, webServerWorkerGid);
+<a name="l00306"></a>00306                 <span class="keywordflow">return</span> generation;
+<a name="l00307"></a>00307         }
+<a name="l00308"></a>00308
+<a name="l00309"></a>00309         GenerationPtr getGeneration(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number)<span class="keyword"> const </span>{
+<a name="l00310"></a>00310                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> Generation(path, number));
+<a name="l00311"></a>00311         }
+<a name="l00312"></a>00312
+<a name="l00313"></a>00313         GenerationPtr getNewestGeneration()<span class="keyword"> const </span>{
+<a name="l00314"></a>00314                 DIR *dir = opendir(path.c_str());
+<a name="l00315"></a>00315                 <span class="keyword">struct </span>dirent *entry;
+<a name="l00316"></a>00316                 <span class="keywordtype">int</span> result = -1;
+<a name="l00317"></a>00317
+<a name="l00318"></a>00318                 <span class="keywordflow">if</span> (dir == NULL) {
+<a name="l00319"></a>00319                         <span class="keywordtype">int</span> e = errno;
+<a name="l00320"></a>00320                         <span class="keywordflow">throw</span> FileSystemException(<span class="stringliteral">&quot;Cannot open directory &quot;</span> + path,
+<a name="l00321"></a>00321                                 e, path);
+<a name="l00322"></a>00322                 }
+<a name="l00323"></a>00323                 <span class="keywordflow">while</span> ((entry = readdir(dir)) != NULL) {
+<a name="l00324"></a>00324                         <span class="keywordflow">if</span> (isDirectory(path, entry)
+<a name="l00325"></a>00325                          &amp;&amp; strncmp(entry-&gt;d_name, <span class="stringliteral">&quot;generation-&quot;</span>, <span class="keyword">sizeof</span>(<span class="stringliteral">&quot;generation-&quot;</span>) - 1) == 0) {
+<a name="l00326"></a>00326                                 <span class="keyword">const</span> <span class="keywordtype">char</span> *numberString = entry-&gt;d_name + <span class="keyword">sizeof</span>(<span class="stringliteral">&quot;generation-&quot;</span>) - 1;
+<a name="l00327"></a>00327                                 <span class="keywordtype">int</span> number = atoi(numberString);
+<a name="l00328"></a>00328                                 <span class="keywordflow">if</span> (number &gt;= 0 &amp;&amp; number &gt; result) {
+<a name="l00329"></a>00329                                         result = number;
+<a name="l00330"></a>00330                                 }
+<a name="l00331"></a>00331                         }
+<a name="l00332"></a>00332                 }
+<a name="l00333"></a>00333                 closedir(dir);
+<a name="l00334"></a>00334
+<a name="l00335"></a>00335                 <span class="keywordflow">if</span> (result == -1) {
+<a name="l00336"></a>00336                         <span class="keywordflow">return</span> GenerationPtr();
+<a name="l00337"></a>00337                 } <span class="keywordflow">else</span> {
+<a name="l00338"></a>00338                         <span class="keywordflow">return</span> getGeneration(result);
+<a name="l00339"></a>00339                 }
+<a name="l00340"></a>00340         }
+<a name="l00341"></a>00341 };
+<a name="l00342"></a>00342
+<a name="l00343"></a>00343 <span class="keyword">typedef</span> shared_ptr&lt;ServerInstanceDir&gt; ServerInstanceDirPtr;
+<a name="l00344"></a>00344
+<a name="l00345"></a>00345 } <span class="comment">// namespace Passenger</span>
+<a name="l00346"></a>00346
+<a name="l00347"></a>00347 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SERVER_INSTANCE_DIR_H_ */</span>
+</pre></div></div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>

data/doc/cxxapi/Session_8h_source.html ADDED

@@ -0,0 +1,501 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: Session.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<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>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>Session.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) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; 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"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_SESSION_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SESSION_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;sys/un.h&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;netdb.h&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;cerrno&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;cstring&gt;</span>
+<a name="l00035"></a>00035
+<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;vector&gt;</span>
+<a name="l00038"></a>00038
+<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;boost/function.hpp&gt;</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;oxt/backtrace.hpp&gt;</span>
+<a name="l00042"></a>00042 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
+<a name="l00043"></a>00043
+<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;MessageChannel.h&quot;</span>
+<a name="l00045"></a>00045 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
+<a name="l00046"></a>00046 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
+<a name="l00047"></a>00047 <span class="preprocessor">#include &quot;Utils/StrIntUtils.h&quot;</span>
+<a name="l00048"></a>00048 <span class="preprocessor">#include &quot;Utils/IOUtils.h&quot;</span>
+<a name="l00049"></a>00049
+<a name="l00050"></a>00050 <span class="keyword">namespace </span>Passenger {
+<a name="l00051"></a>00051
+<a name="l00052"></a>00052 <span class="keyword">using namespace </span>boost;
+<a name="l00053"></a>00053 <span class="keyword">using namespace </span>oxt;
+<a name="l00054"></a>00054 <span class="keyword">using namespace </span>std;
+<a name="l00055"></a>00055
+<a name="l00056"></a>00056 <span class="comment"></span>
+<a name="l00057"></a>00057 <span class="comment">/**</span>
+<a name="l00058"></a>00058 <span class="comment"> * Represents a single request/response pair of an application process.</span>
+<a name="l00059"></a>00059 <span class="comment"> *</span>
+<a name="l00060"></a>00060 <span class="comment"> * Session is used to forward a single HTTP request to an application</span>
+<a name="l00061"></a>00061 <span class="comment"> * process, and to read back the HTTP response. A Session object is to</span>
+<a name="l00062"></a>00062 <span class="comment"> * be used in the following manner:</span>
+<a name="l00063"></a>00063 <span class="comment"> *</span>
+<a name="l00064"></a>00064 <span class="comment"> *  -# Serialize the HTTP request headers into a format as expected by</span>
+<a name="l00065"></a>00065 <span class="comment"> *     sendHeaders(), then send that string by calling sendHeaders().</span>
+<a name="l00066"></a>00066 <span class="comment"> *  -# In case of a POST of PUT request, send the HTTP request body by</span>
+<a name="l00067"></a>00067 <span class="comment"> *     calling sendBodyBlock(), possibly multiple times.</span>
+<a name="l00068"></a>00068 <span class="comment"> *  -# Shutdown the writer end of the session channel (shutdownWriter())</span>
+<a name="l00069"></a>00069 <span class="comment"> *     since you&#39;re now done sending data.</span>
+<a name="l00070"></a>00070 <span class="comment"> *  -# The HTTP response can now be read through the session 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 Process::newSession().</span>
+<a name="l00075"></a>00075 <span class="comment"> *</span>
+<a name="l00076"></a>00076 <span class="comment"> * Session is an abstract base class. Concrete implementations can be found in</span>
+<a name="l00077"></a>00077 <span class="comment"> * StandardSession and ApplicationPool::Client::RemoteSession.</span>
+<a name="l00078"></a>00078 <span class="comment"> *</span>
+<a name="l00079"></a>00079 <span class="comment"> * Session is not guaranteed to be thread-safe.</span>
+<a name="l00080"></a>00080 <span class="comment"> */</span>
+<a name="l00081"></a><a class="code" href="classPassenger_1_1Session.html">00081</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> {
+<a name="l00082"></a>00082 <span class="keyword">protected</span>:
+<a name="l00083"></a>00083         <span class="keywordtype">string</span> detachKey;
+<a name="l00084"></a>00084         <span class="keywordtype">string</span> connectPassword;
+<a name="l00085"></a>00085         <span class="keywordtype">string</span> gupid;
+<a name="l00086"></a>00086
+<a name="l00087"></a>00087 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00088"></a>00088 <span class="comment">        /**</span>
+<a name="l00089"></a>00089 <span class="comment">         * Concrete classes might throw arbitrary exceptions.</span>
+<a name="l00090"></a>00090 <span class="comment">         */</span>
+<a name="l00091"></a><a class="code" href="classPassenger_1_1Session.html#ac982015e84f64dbec70daef8fdbd31d9">00091</a>         <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Session.html#ac982015e84f64dbec70daef8fdbd31d9" title="Concrete classes might throw arbitrary exceptions.">~Session</a>() {}
+<a name="l00092"></a>00092         <span class="comment"></span>
+<a name="l00093"></a>00093 <span class="comment">        /**</span>
+<a name="l00094"></a>00094 <span class="comment">         * Initiate the session by connecting to the associated process.</span>
+<a name="l00095"></a>00095 <span class="comment">         * A Session is not usable until it&#39;s initiated.</span>
+<a name="l00096"></a>00096 <span class="comment">         *</span>
+<a name="l00097"></a>00097 <span class="comment">         * @throws SystemException Something went wrong.</span>
+<a name="l00098"></a>00098 <span class="comment">         * @throws IOException Something went wrong.</span>
+<a name="l00099"></a>00099 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00100"></a>00100 <span class="comment">         */</span>
+<a name="l00101"></a>00101         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#abbcfa3eb48d38dead20c0d32cab4850b" title="Initiate the session by connecting to the associated process.">initiate</a>() = 0;
+<a name="l00102"></a>00102         <span class="comment"></span>
+<a name="l00103"></a>00103 <span class="comment">        /**</span>
+<a name="l00104"></a>00104 <span class="comment">         * Returns whether this session has been initiated (that is, whether</span>
+<a name="l00105"></a>00105 <span class="comment">         * initiate() had been called in the past).</span>
+<a name="l00106"></a>00106 <span class="comment">         */</span>
+<a name="l00107"></a>00107         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated</a>() <span class="keyword">const</span> = 0;
+<a name="l00108"></a>00108         <span class="comment"></span>
+<a name="l00109"></a>00109 <span class="comment">        /**</span>
+<a name="l00110"></a>00110 <span class="comment">         * Returns the type of the socket that this session is served from,</span>
+<a name="l00111"></a>00111 <span class="comment">         * e.g. &quot;unix&quot; indicating a Unix socket.</span>
+<a name="l00112"></a>00112 <span class="comment">         *</span>
+<a name="l00113"></a>00113 <span class="comment">         * @post !result.empty()</span>
+<a name="l00114"></a>00114 <span class="comment">         */</span>
+<a name="l00115"></a>00115         <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#ab8f084ab143d44f1a9ef8e8ccc841485" title="Returns the type of the socket that this session is served from, e.g.">getSocketType</a>() <span class="keyword">const</span> = 0;
+<a name="l00116"></a>00116         <span class="comment"></span>
+<a name="l00117"></a>00117 <span class="comment">        /**</span>
+<a name="l00118"></a>00118 <span class="comment">         * Returns the address of the socket that this session is served</span>
+<a name="l00119"></a>00119 <span class="comment">         * from. This can be a Unix socket filename or a TCP host:port string</span>
+<a name="l00120"></a>00120 <span class="comment">         * like &quot;127.0.0.1:1234&quot;.</span>
+<a name="l00121"></a>00121 <span class="comment">         *</span>
+<a name="l00122"></a>00122 <span class="comment">         * @post !result.empty()</span>
+<a name="l00123"></a>00123 <span class="comment">         */</span>
+<a name="l00124"></a>00124         <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#a7b8a632ebde11544a8ab98fde89954bb" title="Returns the address of the socket that this session is served from.">getSocketName</a>() <span class="keyword">const</span> = 0;
+<a name="l00125"></a>00125         <span class="comment"></span>
+<a name="l00126"></a>00126 <span class="comment">        /**</span>
+<a name="l00127"></a>00127 <span class="comment">         * Send HTTP request headers to the application. The HTTP headers must be</span>
+<a name="l00128"></a>00128 <span class="comment">         * converted into CGI headers, and then encoded into a string that matches this grammar:</span>
+<a name="l00129"></a>00129 <span class="comment">         *</span>
+<a name="l00130"></a>00130 <span class="comment">           @verbatim</span>
+<a name="l00131"></a>00131 <span class="comment">           headers ::= header*</span>
+<a name="l00132"></a>00132 <span class="comment">           header ::= name NUL value NUL</span>
+<a name="l00133"></a>00133 <span class="comment">           name ::= notnull+</span>
+<a name="l00134"></a>00134 <span class="comment">           value ::= notnull+</span>
+<a name="l00135"></a>00135 <span class="comment">           notnull ::= &quot;\x01&quot; | &quot;\x02&quot; | &quot;\x02&quot; | ... | &quot;\xFF&quot;</span>
+<a name="l00136"></a>00136 <span class="comment">           NUL = &quot;\x00&quot;</span>
+<a name="l00137"></a>00137 <span class="comment">           @endverbatim</span>
+<a name="l00138"></a>00138 <span class="comment">         *</span>
+<a name="l00139"></a>00139 <span class="comment">         * There must be a header with the name &quot;PASSWORD_CONNECT_PASSWORD&quot;, and it must</span>
+<a name="l00140"></a>00140 <span class="comment">         * have the same value as the string returned by getConnectPassword().</span>
+<a name="l00141"></a>00141 <span class="comment">         *</span>
+<a name="l00142"></a>00142 <span class="comment">         * This method should be the first one to be called during the lifetime of a Session</span>
+<a name="l00143"></a>00143 <span class="comment">         * object, otherwise strange things may happen.</span>
+<a name="l00144"></a>00144 <span class="comment">         *</span>
+<a name="l00145"></a>00145 <span class="comment">         * @param headers The HTTP request headers, converted into CGI headers and encoded as</span>
+<a name="l00146"></a>00146 <span class="comment">         *                a string, according to the description.</span>
+<a name="l00147"></a>00147 <span class="comment">         * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span>
+<a name="l00148"></a>00148 <span class="comment">         * @pre headers != NULL</span>
+<a name="l00149"></a>00149 <span class="comment">         * @pre initiated()</span>
+<a name="l00150"></a>00150 <span class="comment">         * @throws IOException The I/O channel has already been closed or discarded.</span>
+<a name="l00151"></a>00151 <span class="comment">         * @throws SystemException Something went wrong during writing.</span>
+<a name="l00152"></a>00152 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00153"></a>00153 <span class="comment">         */</span>
+<a name="l00154"></a><a class="code" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671">00154</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" 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="l00155"></a>00155                 TRACE_POINT();
+<a name="l00156"></a>00156                 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>();
+<a name="l00157"></a>00157                 <span class="keywordflow">if</span> (stream == -1) {
+<a name="l00158"></a>00158                         <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">&quot;Cannot write headers to the request handler &quot;</span>
+<a name="l00159"></a>00159                                 <span class="stringliteral">&quot;because the I/O stream has already been closed or discarded.&quot;</span>);
+<a name="l00160"></a>00160                 }
+<a name="l00161"></a>00161                 <span class="keywordflow">try</span> {
+<a name="l00162"></a>00162                         <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeScalar(headers, size);
+<a name="l00163"></a>00163                 } <span class="keywordflow">catch</span> (<a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) {
+<a name="l00164"></a>00164                         e.setBriefMessage(<span class="stringliteral">&quot;An error occured while writing headers &quot;</span>
+<a name="l00165"></a>00165                                 <span class="stringliteral">&quot;to the request handler&quot;</span>);
+<a name="l00166"></a>00166                         <span class="keywordflow">throw</span>;
+<a name="l00167"></a>00167                 }
+<a name="l00168"></a>00168         }
+<a name="l00169"></a>00169         <span class="comment"></span>
+<a name="l00170"></a>00170 <span class="comment">        /**</span>
+<a name="l00171"></a>00171 <span class="comment">         * Convenience shortcut for sendHeaders(const char *, unsigned int)</span>
+<a name="l00172"></a>00172 <span class="comment">         * @param headers The headers</span>
+<a name="l00173"></a>00173 <span class="comment">         * @pre initiated()</span>
+<a name="l00174"></a>00174 <span class="comment">         * @throws IOException The I/O channel has already been closed or discarded.</span>
+<a name="l00175"></a>00175 <span class="comment">         * @throws SystemException Something went wrong during writing.</span>
+<a name="l00176"></a>00176 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00177"></a>00177 <span class="comment">         */</span>
+<a name="l00178"></a><a class="code" href="classPassenger_1_1Session.html#a8253d81e64adc0dc72b1dc65a5117aba">00178</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a8253d81e64adc0dc72b1dc65a5117aba" title="Convenience shortcut for sendHeaders(const char *, unsigned int).">sendHeaders</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &amp;headers) {
+<a name="l00179"></a>00179                 <a class="code" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders</a>(headers.c_str(), headers.size());
+<a name="l00180"></a>00180         }
+<a name="l00181"></a>00181         <span class="comment"></span>
+<a name="l00182"></a>00182 <span class="comment">        /**</span>
+<a name="l00183"></a>00183 <span class="comment">         * Send a chunk of HTTP request body data to the application.</span>
+<a name="l00184"></a>00184 <span class="comment">         * You can call this method as many times as is required to transfer</span>
+<a name="l00185"></a>00185 <span class="comment">         * the entire HTTP request body.</span>
+<a name="l00186"></a>00186 <span class="comment">         *</span>
+<a name="l00187"></a>00187 <span class="comment">         * This method must only be called after a sendHeaders(), otherwise</span>
+<a name="l00188"></a>00188 <span class="comment">         * strange things may happen.</span>
+<a name="l00189"></a>00189 <span class="comment">         *</span>
+<a name="l00190"></a>00190 <span class="comment">         * @param block A block of HTTP request body data to send.</span>
+<a name="l00191"></a>00191 <span class="comment">         * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span>
+<a name="l00192"></a>00192 <span class="comment">         * @pre initiated()</span>
+<a name="l00193"></a>00193 <span class="comment">         * @throws IOException The I/O channel has already been closed or discarded.</span>
+<a name="l00194"></a>00194 <span class="comment">         * @throws SystemException Something went wrong during writing.</span>
+<a name="l00195"></a>00195 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00196"></a>00196 <span class="comment">         */</span>
+<a name="l00197"></a><a class="code" href="classPassenger_1_1Session.html#a2203d81e25fe5066aed351608deecf7b">00197</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a2203d81e25fe5066aed351608deecf7b" 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="l00198"></a>00198                 TRACE_POINT();
+<a name="l00199"></a>00199                 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>();
+<a name="l00200"></a>00200                 <span class="keywordflow">if</span> (stream == -1) {
+<a name="l00201"></a>00201                         <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">&quot;Cannot write request body block to the &quot;</span>
+<a name="l00202"></a>00202                                 <span class="stringliteral">&quot;request handler because the I/O channel has &quot;</span>
+<a name="l00203"></a>00203                                 <span class="stringliteral">&quot;already been closed or discarded.&quot;</span>);
+<a name="l00204"></a>00204                 }
+<a name="l00205"></a>00205                 <span class="keywordflow">try</span> {
+<a name="l00206"></a>00206                         writeExact(stream, block, size);
+<a name="l00207"></a>00207                 } <span class="keywordflow">catch</span> (<a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;e) {
+<a name="l00208"></a>00208                         e.setBriefMessage(<span class="stringliteral">&quot;An error occured while sending the &quot;</span>
+<a name="l00209"></a>00209                                 <span class="stringliteral">&quot;request body to the request handler&quot;</span>);
+<a name="l00210"></a>00210                         <span class="keywordflow">throw</span>;
+<a name="l00211"></a>00211                 }
+<a name="l00212"></a>00212         }
+<a name="l00213"></a>00213         <span class="comment"></span>
+<a name="l00214"></a>00214 <span class="comment">        /**</span>
+<a name="l00215"></a>00215 <span class="comment">         * Returns this session&#39;s channel&#39;s file descriptor. This stream is</span>
+<a name="l00216"></a>00216 <span class="comment">         * full-duplex, and will be automatically closed upon Session&#39;s</span>
+<a name="l00217"></a>00217 <span class="comment">         * destruction, unless discardStream() is called.</span>
+<a name="l00218"></a>00218 <span class="comment">         *</span>
+<a name="l00219"></a>00219 <span class="comment">         * @pre initiated()</span>
+<a name="l00220"></a>00220 <span class="comment">         * @returns The file descriptor, or -1 if the I/O channel has already</span>
+<a name="l00221"></a>00221 <span class="comment">         *          been closed or discarded.</span>
+<a name="l00222"></a>00222 <span class="comment">         */</span>
+<a name="l00223"></a>00223         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0;
+<a name="l00224"></a>00224         <span class="comment"></span>
+<a name="l00225"></a>00225 <span class="comment">        /**</span>
+<a name="l00226"></a>00226 <span class="comment">         * Set the timeout value for reading data from the I/O channel.</span>
+<a name="l00227"></a>00227 <span class="comment">         * If no data can be read within the timeout period, then the</span>
+<a name="l00228"></a>00228 <span class="comment">         * read call will fail with error EAGAIN or EWOULDBLOCK.</span>
+<a name="l00229"></a>00229 <span class="comment">         *</span>
+<a name="l00230"></a>00230 <span class="comment">         * @pre The I/O channel hasn&#39;t been closed or discarded.</span>
+<a name="l00231"></a>00231 <span class="comment">         * @pre initiated()</span>
+<a name="l00232"></a>00232 <span class="comment">         * @param msec The timeout, in milliseconds. If 0 is given,</span>
+<a name="l00233"></a>00233 <span class="comment">         *             there will be no timeout.</span>
+<a name="l00234"></a>00234 <span class="comment">         * @throws SystemException Cannot set the timeout.</span>
+<a name="l00235"></a>00235 <span class="comment">         */</span>
+<a name="l00236"></a>00236         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a5accbd8f7cce66d0ef6695481fdaa39c" title="Set the timeout value for reading data from the I/O channel.">setReaderTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) = 0;
+<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">         * Set the timeout value for writing data from the I/O channel.</span>
+<a name="l00240"></a>00240 <span class="comment">         * If no data can be written within the timeout period, then the</span>
+<a name="l00241"></a>00241 <span class="comment">         * write call will fail with error EAGAIN or EWOULDBLOCK.</span>
+<a name="l00242"></a>00242 <span class="comment">         *</span>
+<a name="l00243"></a>00243 <span class="comment">         * @pre The I/O channel hasn&#39;t been closed or discarded.</span>
+<a name="l00244"></a>00244 <span class="comment">         * @pre initiated()</span>
+<a name="l00245"></a>00245 <span class="comment">         * @param msec The timeout, in milliseconds. If 0 is given,</span>
+<a name="l00246"></a>00246 <span class="comment">         *             there will be no timeout.</span>
+<a name="l00247"></a>00247 <span class="comment">         * @throws SystemException Cannot set the timeout.</span>
+<a name="l00248"></a>00248 <span class="comment">         */</span>
+<a name="l00249"></a>00249         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a21dd749c0c8d22f65c6a914ec2f97c94" title="Set the timeout value for writing data from the I/O channel.">setWriterTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) = 0;
+<a name="l00250"></a>00250         <span class="comment"></span>
+<a name="l00251"></a>00251 <span class="comment">        /**</span>
+<a name="l00252"></a>00252 <span class="comment">         * Indicate that we don&#39;t want to read data anymore from the I/O channel.</span>
+<a name="l00253"></a>00253 <span class="comment">         * Calling this method after closeStream()/discardStream() is called will</span>
+<a name="l00254"></a>00254 <span class="comment">         * have no effect.</span>
+<a name="l00255"></a>00255 <span class="comment">         *</span>
+<a name="l00256"></a>00256 <span class="comment">         * @pre initiated()</span>
+<a name="l00257"></a>00257 <span class="comment">         * @throws SystemException Something went wrong.</span>
+<a name="l00258"></a>00258 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00259"></a>00259 <span class="comment">         */</span>
+<a name="l00260"></a>00260         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#ac579d233ddc82542c336b2af1f40c4dd" title="Indicate that we don&amp;#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() = 0;
+<a name="l00261"></a>00261         <span class="comment"></span>
+<a name="l00262"></a>00262 <span class="comment">        /**</span>
+<a name="l00263"></a>00263 <span class="comment">         * Indicate that we don&#39;t want to write data anymore to the I/O channel.</span>
+<a name="l00264"></a>00264 <span class="comment">         * Calling this method after closeStream()/discardStream() is called will</span>
+<a name="l00265"></a>00265 <span class="comment">         * have no effect.</span>
+<a name="l00266"></a>00266 <span class="comment">         *</span>
+<a name="l00267"></a>00267 <span class="comment">         * @pre initiated()</span>
+<a name="l00268"></a>00268 <span class="comment">         * @throws SystemException Something went wrong.</span>
+<a name="l00269"></a>00269 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00270"></a>00270 <span class="comment">         */</span>
+<a name="l00271"></a>00271         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a8263c568a8ac4567b33728d820cbd920" title="Indicate that we don&amp;#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() = 0;
+<a name="l00272"></a>00272         <span class="comment"></span>
+<a name="l00273"></a>00273 <span class="comment">        /**</span>
+<a name="l00274"></a>00274 <span class="comment">         * Close the I/O stream.</span>
+<a name="l00275"></a>00275 <span class="comment">         *</span>
+<a name="l00276"></a>00276 <span class="comment">         * @throws SystemException Something went wrong.</span>
+<a name="l00277"></a>00277 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00278"></a>00278 <span class="comment">         * @pre initiated()</span>
+<a name="l00279"></a>00279 <span class="comment">         * @post getStream() == -1</span>
+<a name="l00280"></a>00280 <span class="comment">         */</span>
+<a name="l00281"></a>00281         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a7ab85388f15388cb8e65873d1ad310a5" title="Close the I/O stream.">closeStream</a>() = 0;
+<a name="l00282"></a>00282         <span class="comment"></span>
+<a name="l00283"></a>00283 <span class="comment">        /**</span>
+<a name="l00284"></a>00284 <span class="comment">         * Discard the I/O channel&#39;s file descriptor, so that the destructor</span>
+<a name="l00285"></a>00285 <span class="comment">         * won&#39;t automatically close it.</span>
+<a name="l00286"></a>00286 <span class="comment">         *</span>
+<a name="l00287"></a>00287 <span class="comment">         * @pre initiated()</span>
+<a name="l00288"></a>00288 <span class="comment">         * @post getStream() == -1</span>
+<a name="l00289"></a>00289 <span class="comment">         */</span>
+<a name="l00290"></a>00290         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#a75344fdfb3c693323877e32884efaa31" title="Discard the I/O channel&amp;#39;s file descriptor, so that the destructor won&amp;#39;t automatically...">discardStream</a>() = 0;
+<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">         * Get the process ID of the application process that this session</span>
+<a name="l00294"></a>00294 <span class="comment">         * belongs to.</span>
+<a name="l00295"></a>00295 <span class="comment">         */</span>
+<a name="l00296"></a>00296         <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Session.html#a1b58af5493a61bfe4efbd725dcef61a3" title="Get the process ID of the application process that this session belongs to.">getPid</a>() <span class="keyword">const</span> = 0;
+<a name="l00297"></a>00297
+<a name="l00298"></a>00298         <span class="keyword">const</span> <span class="keywordtype">string</span> getDetachKey()<span class="keyword"> const </span>{
+<a name="l00299"></a>00299                 <span class="keywordflow">return</span> detachKey;
+<a name="l00300"></a>00300         }
+<a name="l00301"></a>00301         <span class="comment"></span>
+<a name="l00302"></a>00302 <span class="comment">        /**</span>
+<a name="l00303"></a>00303 <span class="comment">         * Returns this session&#39;s process&#39;s connect password. This password is</span>
+<a name="l00304"></a>00304 <span class="comment">         * guaranteed to be valid ASCII.</span>
+<a name="l00305"></a>00305 <span class="comment">         */</span>
+<a name="l00306"></a><a class="code" href="classPassenger_1_1Session.html#aeaf4f7097f7b3430dc88e8070cad5899">00306</a>         <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#aeaf4f7097f7b3430dc88e8070cad5899" title="Returns this session&amp;#39;s process&amp;#39;s connect password.">getConnectPassword</a>()<span class="keyword"> const </span>{
+<a name="l00307"></a>00307                 <span class="keywordflow">return</span> connectPassword;
+<a name="l00308"></a>00308         }
+<a name="l00309"></a>00309
+<a name="l00310"></a>00310         <span class="keyword">const</span> <span class="keywordtype">string</span> getGupid()<span class="keyword"> const </span>{
+<a name="l00311"></a>00311                 <span class="keywordflow">return</span> gupid;
+<a name="l00312"></a>00312         }
+<a name="l00313"></a>00313 };
+<a name="l00314"></a>00314
+<a name="l00315"></a>00315 <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; SessionPtr;
+<a name="l00316"></a>00316
+<a name="l00317"></a>00317 <span class="comment"></span>
+<a name="l00318"></a>00318 <span class="comment">/**</span>
+<a name="l00319"></a>00319 <span class="comment"> * A &quot;standard&quot; implementation of Session.</span>
+<a name="l00320"></a>00320 <span class="comment"> */</span>
+<a name="l00321"></a><a class="code" href="classPassenger_1_1StandardSession.html">00321</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>: <span class="keyword">public</span> <a class="code" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> {
+<a name="l00322"></a>00322 <span class="keyword">public</span>:
+<a name="l00323"></a>00323         <span class="keyword">typedef</span> function&lt;void (const StandardSession *)&gt; CloseCallback;
+<a name="l00324"></a>00324
+<a name="l00325"></a>00325 <span class="keyword">protected</span>:
+<a name="l00326"></a>00326         pid_t pid;
+<a name="l00327"></a>00327         CloseCallback closeCallback;
+<a name="l00328"></a>00328         <span class="keywordtype">string</span> socketType;
+<a name="l00329"></a>00329         <span class="keywordtype">string</span> socketName;
+<a name="l00330"></a>00330         <span class="comment"></span>
+<a name="l00331"></a>00331 <span class="comment">        /** The session connection file descriptor. */</span>
+<a name="l00332"></a><a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9">00332</a>         <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>;
+<a name="l00333"></a>00333         <span class="keywordtype">bool</span> isInitiated;
+<a name="l00334"></a>00334
+<a name="l00335"></a>00335 <span class="keyword">public</span>:
+<a name="l00336"></a>00336         <a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>(pid_t pid,
+<a name="l00337"></a>00337                         <span class="keyword">const</span> CloseCallback &amp;closeCallback,
+<a name="l00338"></a>00338                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketType,
+<a name="l00339"></a>00339                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketName,
+<a name="l00340"></a>00340                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;detachKey,
+<a name="l00341"></a>00341                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;connectPassword,
+<a name="l00342"></a>00342                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;gupid)
+<a name="l00343"></a>00343         {
+<a name="l00344"></a>00344                 TRACE_POINT();
+<a name="l00345"></a>00345                 <span class="keywordflow">if</span> (socketType != <span class="stringliteral">&quot;unix&quot;</span> &amp;&amp; socketType != <span class="stringliteral">&quot;tcp&quot;</span>) {
+<a name="l00346"></a>00346                         <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">&quot;Unsupported socket type &#39;&quot;</span> + socketType + <span class="stringliteral">&quot;&#39;&quot;</span>);
+<a name="l00347"></a>00347                 }
+<a name="l00348"></a>00348                 this-&gt;pid = pid;
+<a name="l00349"></a>00349                 this-&gt;closeCallback = closeCallback;
+<a name="l00350"></a>00350                 this-&gt;socketType    = socketType;
+<a name="l00351"></a>00351                 this-&gt;socketName    = socketName;
+<a name="l00352"></a>00352                 this-&gt;detachKey     = detachKey;
+<a name="l00353"></a>00353                 this-&gt;connectPassword = connectPassword;
+<a name="l00354"></a>00354                 this-&gt;gupid         = gupid;
+<a name="l00355"></a>00355                 <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
+<a name="l00356"></a>00356                 isInitiated = <span class="keyword">false</span>;
+<a name="l00357"></a>00357         }
+<a name="l00358"></a>00358
+<a name="l00359"></a>00359         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>() {
+<a name="l00360"></a>00360                 TRACE_POINT();
+<a name="l00361"></a>00361                 <a class="code" href="classPassenger_1_1StandardSession.html#af5cdfa78db1fca6303ccd43ac5126b6b" title="Close the I/O stream.">closeStream</a>();
+<a name="l00362"></a>00362                 <span class="keywordflow">if</span> (closeCallback != NULL) {
+<a name="l00363"></a>00363                         closeCallback(<span class="keyword">this</span>);
+<a name="l00364"></a>00364                 }
+<a name="l00365"></a>00365         }
+<a name="l00366"></a>00366
+<a name="l00367"></a><a class="code" href="classPassenger_1_1StandardSession.html#ac283db6faf2fcd1827baf3ebac276677">00367</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#ac283db6faf2fcd1827baf3ebac276677" title="Initiate the session by connecting to the associated process.">initiate</a>() {
+<a name="l00368"></a>00368                 TRACE_POINT();
+<a name="l00369"></a>00369                 <span class="keywordflow">if</span> (socketType == <span class="stringliteral">&quot;unix&quot;</span>) {
+<a name="l00370"></a>00370                         <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = connectToUnixServer(socketName.c_str());
+<a name="l00371"></a>00371                 } <span class="keywordflow">else</span> {
+<a name="l00372"></a>00372                         vector&lt;string&gt; args;
+<a name="l00373"></a>00373
+<a name="l00374"></a>00374                         split(socketName, <span class="charliteral">&#39;:&#39;</span>, args);
+<a name="l00375"></a>00375                         <span class="keywordflow">if</span> (args.size() != 2 || atoi(args[1]) == 0) {
+<a name="l00376"></a>00376                                 UPDATE_TRACE_POINT();
+<a name="l00377"></a>00377                                 <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">&quot;Invalid TCP/IP address &#39;&quot;</span> + socketName + <span class="stringliteral">&quot;&#39;&quot;</span>);
+<a name="l00378"></a>00378                         }
+<a name="l00379"></a>00379                         <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = connectToTcpServer(args[0].c_str(), atoi(args[1]));
+<a name="l00380"></a>00380                 }
+<a name="l00381"></a>00381                 isInitiated = <span class="keyword">true</span>;
+<a name="l00382"></a>00382         }
+<a name="l00383"></a>00383
+<a name="l00384"></a><a class="code" href="classPassenger_1_1StandardSession.html#a40cdaad38dfbb7995955f11bb27bba61">00384</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1StandardSession.html#a40cdaad38dfbb7995955f11bb27bba61" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated</a>()<span class="keyword"> const </span>{
+<a name="l00385"></a>00385                 <span class="keywordflow">return</span> isInitiated;
+<a name="l00386"></a>00386         }
+<a name="l00387"></a>00387
+<a name="l00388"></a><a class="code" href="classPassenger_1_1StandardSession.html#a3a59997280d5f7fcaa901716cd8451a2">00388</a>         <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1StandardSession.html#a3a59997280d5f7fcaa901716cd8451a2" title="Returns the type of the socket that this session is served from, e.g.">getSocketType</a>()<span class="keyword"> const </span>{
+<a name="l00389"></a>00389                 <span class="keywordflow">return</span> socketType;
+<a name="l00390"></a>00390         }
+<a name="l00391"></a>00391
+<a name="l00392"></a><a class="code" href="classPassenger_1_1StandardSession.html#a720e98b8dd246eeca004c8e625c0d4d3">00392</a>         <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1StandardSession.html#a720e98b8dd246eeca004c8e625c0d4d3" title="Returns the address of the socket that this session is served from.">getSocketName</a>()<span class="keyword"> const </span>{
+<a name="l00393"></a>00393                 <span class="keywordflow">return</span> socketName;
+<a name="l00394"></a>00394         }
+<a name="l00395"></a>00395
+<a name="l00396"></a><a class="code" href="classPassenger_1_1StandardSession.html#aa3491d2151ba3b94c1b19a4f18bade6a">00396</a>         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1StandardSession.html#aa3491d2151ba3b94c1b19a4f18bade6a" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>()<span class="keyword"> const </span>{
+<a name="l00397"></a>00397                 <span class="keywordflow">return</span> <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>;
+<a name="l00398"></a>00398         }
+<a name="l00399"></a>00399
+<a name="l00400"></a><a class="code" href="classPassenger_1_1StandardSession.html#a960346d8c27ff1ae9017d753e41a159a">00400</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#a960346d8c27ff1ae9017d753e41a159a" title="Set the timeout value for reading data from the I/O channel.">setReaderTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
+<a name="l00401"></a>00401                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>).setReadTimeout(msec);
+<a name="l00402"></a>00402         }
+<a name="l00403"></a>00403
+<a name="l00404"></a><a class="code" href="classPassenger_1_1StandardSession.html#abb51c323ac0e24011191862f6dec7a75">00404</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#abb51c323ac0e24011191862f6dec7a75" title="Set the timeout value for writing data from the I/O channel.">setWriterTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
+<a name="l00405"></a>00405                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>).setWriteTimeout(msec);
+<a name="l00406"></a>00406         }
+<a name="l00407"></a>00407
+<a name="l00408"></a><a class="code" href="classPassenger_1_1StandardSession.html#ac92d4d081d6145ba8d441c8cf88fae74">00408</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#ac92d4d081d6145ba8d441c8cf88fae74" title="Indicate that we don&amp;#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() {
+<a name="l00409"></a>00409                 TRACE_POINT();
+<a name="l00410"></a>00410                 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
+<a name="l00411"></a>00411                         <span class="keywordtype">int</span> ret = syscalls::shutdown(<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>, SHUT_RD);
+<a name="l00412"></a>00412                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00413"></a>00413                                 <span class="keywordtype">int</span> e = errno;
+<a name="l00414"></a>00414                                 <span class="comment">// ENOTCONN is harmless here.</span>
+<a name="l00415"></a>00415                                 <span class="keywordflow">if</span> (e != ENOTCONN) {
+<a name="l00416"></a>00416                                         <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">&quot;Cannot shutdown the reader stream&quot;</span>,
+<a name="l00417"></a>00417                                                 e);
+<a name="l00418"></a>00418                                 }
+<a name="l00419"></a>00419                         }
+<a name="l00420"></a>00420                 }
+<a name="l00421"></a>00421         }
+<a name="l00422"></a>00422
+<a name="l00423"></a><a class="code" href="classPassenger_1_1StandardSession.html#a045a8f7f849c34086b0832fdba7a2915">00423</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#a045a8f7f849c34086b0832fdba7a2915" title="Indicate that we don&amp;#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() {
+<a name="l00424"></a>00424                 TRACE_POINT();
+<a name="l00425"></a>00425                 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
+<a name="l00426"></a>00426                         <span class="keywordtype">int</span> ret = syscalls::shutdown(<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>, SHUT_WR);
+<a name="l00427"></a>00427                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00428"></a>00428                                 <span class="keywordtype">int</span> e = errno;
+<a name="l00429"></a>00429                                 <span class="comment">// ENOTCONN is harmless here.</span>
+<a name="l00430"></a>00430                                 <span class="keywordflow">if</span> (e != ENOTCONN) {
+<a name="l00431"></a>00431                                         <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">&quot;Cannot shutdown the writer stream&quot;</span>,
+<a name="l00432"></a>00432                                                 e);
+<a name="l00433"></a>00433                                 }
+<a name="l00434"></a>00434                         }
+<a name="l00435"></a>00435                 }
+<a name="l00436"></a>00436         }
+<a name="l00437"></a>00437
+<a name="l00438"></a><a class="code" href="classPassenger_1_1StandardSession.html#af5cdfa78db1fca6303ccd43ac5126b6b">00438</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#af5cdfa78db1fca6303ccd43ac5126b6b" title="Close the I/O stream.">closeStream</a>() {
+<a name="l00439"></a>00439                 TRACE_POINT();
+<a name="l00440"></a>00440                 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
+<a name="l00441"></a>00441                         <span class="keywordtype">int</span> ret = syscalls::close(<a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>);
+<a name="l00442"></a>00442                         <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
+<a name="l00443"></a>00443                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00444"></a>00444                                 <span class="keywordtype">int</span> e = errno;
+<a name="l00445"></a>00445                                 <span class="keywordflow">if</span> (errno == EIO) {
+<a name="l00446"></a>00446                                         <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>(
+<a name="l00447"></a>00447                                                 <span class="stringliteral">&quot;A write operation on the session stream failed&quot;</span>,
+<a name="l00448"></a>00448                                                 e);
+<a name="l00449"></a>00449                                 } <span class="keywordflow">else</span> {
+<a name="l00450"></a>00450                                         <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>(
+<a name="l00451"></a>00451                                                 <span class="stringliteral">&quot;Cannot close the session stream&quot;</span>,
+<a name="l00452"></a>00452                                                 e);
+<a name="l00453"></a>00453                                 }
+<a name="l00454"></a>00454                         }
+<a name="l00455"></a>00455                 }
+<a name="l00456"></a>00456         }
+<a name="l00457"></a>00457
+<a name="l00458"></a><a class="code" href="classPassenger_1_1StandardSession.html#a3666d401df82696fe945fcbb66804785">00458</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#a3666d401df82696fe945fcbb66804785" title="Discard the I/O channel&amp;#39;s file descriptor, so that the destructor won&amp;#39;t automatically...">discardStream</a>() {
+<a name="l00459"></a>00459                 <a class="code" href="classPassenger_1_1StandardSession.html#a51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
+<a name="l00460"></a>00460         }
+<a name="l00461"></a>00461
+<a name="l00462"></a><a class="code" href="classPassenger_1_1StandardSession.html#a496bbb49ac5f8d86ac6c37e979e7e3e8">00462</a>         <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1StandardSession.html#a496bbb49ac5f8d86ac6c37e979e7e3e8" title="Get the process ID of the application process that this session belongs to.">getPid</a>()<span class="keyword"> const </span>{
+<a name="l00463"></a>00463                 <span class="keywordflow">return</span> pid;
+<a name="l00464"></a>00464         }
+<a name="l00465"></a>00465 };
+<a name="l00466"></a>00466
+<a name="l00467"></a>00467
+<a name="l00468"></a>00468 } <span class="comment">// namespace Passenger</span>
+<a name="l00469"></a>00469
+<a name="l00470"></a>00470 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SESSION_H_ */</span>
+</pre></div></div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>