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

passenger 3.0.3 → 3.0.4

Potentially problematic release.

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

Files changed (621) hide show

data/doc/cxxapi/classPassenger_1_1Session.html DELETED

@@ -1,556 +0,0 @@
-<!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: Passenger::Session Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
-      <li><a href="files.html"><span>Files</span></a></li>
-    </ul>
-  </div>
-  <div class="tabs">
-    <ul>
-      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
-      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
-      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
-    </ul>
-  </div>
-  <div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1Session.html">Session</a>
-  </div>
-</div>
-<div class="contents">
-<h1>Passenger::Session Class Reference</h1><!-- doxytag: class="Passenger::Session" -->
-<p>Represents a single request/response pair of an application process.
-<a href="#_details">More...</a></p>
-<p><code>#include &lt;<a class="el" href="Session_8h_source.html">Session.h</a>&gt;</code></p>
-<div class="dynheader">
-Inheritance diagram for Passenger::Session:</div>
-<div class="dynsection">
-<div class="center"><img src="classPassenger_1_1Session__inherit__graph.png" border="0" usemap="#Passenger_1_1Session_inherit__map" alt="Inheritance graph"/></div>
-<map name="Passenger_1_1Session_inherit__map" id="Passenger_1_1Session_inherit__map">
-<area shape="rect" href="classPassenger_1_1StandardSession.html" title="A &quot;standard&quot; implementation of Session." alt="" coords="5,80,203,107"></map>
-<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
-<p><a href="classPassenger_1_1Session-members.html">List of all members.</a></p>
-<table border="0" cellpadding="0" cellspacing="0">
-<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac982015e84f64dbec70daef8fdbd31d9"></a><!-- doxytag: member="Passenger::Session::~Session" ref="ac982015e84f64dbec70daef8fdbd31d9" args="()" -->
-virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#ac982015e84f64dbec70daef8fdbd31d9">~Session</a> ()</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Concrete classes might throw arbitrary exceptions. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#abbcfa3eb48d38dead20c0d32cab4850b">initiate</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiate the session by connecting to the associated process.  <a href="#abbcfa3eb48d38dead20c0d32cab4850b"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf1b6ba182a0fc66c8e617f74afafb92"></a><!-- doxytag: member="Passenger::Session::initiated" ref="abf1b6ba182a0fc66c8e617f74afafb92" args="() const =0" -->
-virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92">initiated</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether this session has been initiated (that is, whether <a class="el" href="classPassenger_1_1Session.html#abbcfa3eb48d38dead20c0d32cab4850b" title="Initiate the session by connecting to the associated process.">initiate()</a> had been called in the past). <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#ab8f084ab143d44f1a9ef8e8ccc841485">getSocketType</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type of the socket that this session is served from, e.g.  <a href="#ab8f084ab143d44f1a9ef8e8ccc841485"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a7b8a632ebde11544a8ab98fde89954bb">getSocketName</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the address of the socket that this session is served from.  <a href="#a7b8a632ebde11544a8ab98fde89954bb"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671">sendHeaders</a> (const char *headers, unsigned int size)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send HTTP request headers to the application.  <a href="#a8f8a39f78dd2672b00f1ff01e4d6d671"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a8253d81e64adc0dc72b1dc65a5117aba">sendHeaders</a> (const <a class="el" href="classPassenger_1_1StaticString.html">StaticString</a> &amp;headers)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience shortcut for <a class="el" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders(const char *, unsigned int)</a>.  <a href="#a8253d81e64adc0dc72b1dc65a5117aba"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a2203d81e25fe5066aed351608deecf7b">sendBodyBlock</a> (const char *block, unsigned int size)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a chunk of HTTP request body data to the application.  <a href="#a2203d81e25fe5066aed351608deecf7b"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489">getStream</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns this session's channel's file descriptor.  <a href="#a949c7a46f4bb0c628730ded2041d2489"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a5accbd8f7cce66d0ef6695481fdaa39c">setReaderTimeout</a> (unsigned int msec)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the timeout value for reading data from the I/O channel.  <a href="#a5accbd8f7cce66d0ef6695481fdaa39c"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a21dd749c0c8d22f65c6a914ec2f97c94">setWriterTimeout</a> (unsigned int msec)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the timeout value for writing data from the I/O channel.  <a href="#a21dd749c0c8d22f65c6a914ec2f97c94"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#ac579d233ddc82542c336b2af1f40c4dd">shutdownReader</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicate that we don't want to read data anymore from the I/O channel.  <a href="#ac579d233ddc82542c336b2af1f40c4dd"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a8263c568a8ac4567b33728d820cbd920">shutdownWriter</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicate that we don't want to write data anymore to the I/O channel.  <a href="#a8263c568a8ac4567b33728d820cbd920"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a7ab85388f15388cb8e65873d1ad310a5">closeStream</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the I/O stream.  <a href="#a7ab85388f15388cb8e65873d1ad310a5"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a75344fdfb3c693323877e32884efaa31">discardStream</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Discard the I/O channel's file descriptor, so that the destructor won't automatically close it.  <a href="#a75344fdfb3c693323877e32884efaa31"></a><br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b58af5493a61bfe4efbd725dcef61a3"></a><!-- doxytag: member="Passenger::Session::getPid" ref="a1b58af5493a61bfe4efbd725dcef61a3" args="() const =0" -->
-virtual pid_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#a1b58af5493a61bfe4efbd725dcef61a3">getPid</a> () const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the process ID of the application process that this session belongs to. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">const string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1Session.html#aeaf4f7097f7b3430dc88e8070cad5899">getConnectPassword</a> () const </td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns this session's process's connect password.  <a href="#aeaf4f7097f7b3430dc88e8070cad5899"></a><br/></td></tr>
-</table>
-<hr/><a name="_details"></a><h2>Detailed Description</h2>
-<p>Represents a single request/response pair of an application process. </p>
-<p><a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> is used to forward a single HTTP request to an application process, and to read back the HTTP response. A <a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> object is to be used in the following manner:</p>
-<ol type="1">
-<li>Serialize the HTTP request headers into a format as expected by <a class="el" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders()</a>, then send that string by calling <a class="el" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders()</a>.</li>
-<li>In case of a POST of PUT request, send the HTTP request body by calling <a class="el" href="classPassenger_1_1Session.html#a2203d81e25fe5066aed351608deecf7b" title="Send a chunk of HTTP request body data to the application.">sendBodyBlock()</a>, possibly multiple times.</li>
-<li>Shutdown the writer end of the session channel (<a class="el" href="classPassenger_1_1Session.html#a8263c568a8ac4567b33728d820cbd920" title="Indicate that we don&#39;t want to write data anymore to the I/O channel.">shutdownWriter()</a>) since you're now done sending data.</li>
-<li>The HTTP response can now be read through the session channel (<a class="el" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream()</a>).</li>
-<li>When the HTTP response has been read, the session must be closed. This is done by destroying the <a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> object.</li>
-</ol>
-<p>A usage example is shown in <a class="el" href="classPassenger_1_1Process.html#a4df3ce126ba64c864c1759d916f25635" title="Request a new session from this application process by connecting to its main server...">Process::newSession()</a>.</p>
-<p><a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> is an abstract base class. Concrete implementations can be found in <a class="el" href="classPassenger_1_1StandardSession.html" title="A &quot;standard&quot; implementation of Session.">StandardSession</a> and ApplicationPool::Client::RemoteSession.</p>
-<p><a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> is not guaranteed to be thread-safe. </p>
-<hr/><h2>Member Function Documentation</h2>
-<a class="anchor" id="a7ab85388f15388cb8e65873d1ad310a5"></a><!-- doxytag: member="Passenger::Session::closeStream" ref="a7ab85388f15388cb8e65873d1ad310a5" args="()=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::closeStream </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Close the I/O stream. </p>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl class="post"><dt><b>Postcondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream()</a> == -1 </dd></dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#af5cdfa78db1fca6303ccd43ac5126b6b">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="a75344fdfb3c693323877e32884efaa31"></a><!-- doxytag: member="Passenger::Session::discardStream" ref="a75344fdfb3c693323877e32884efaa31" args="()=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::discardStream </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Discard the I/O channel's file descriptor, so that the destructor won't automatically close it. </p>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl class="post"><dt><b>Postcondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#a949c7a46f4bb0c628730ded2041d2489" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream()</a> == -1 </dd></dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#a3666d401df82696fe945fcbb66804785">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="aeaf4f7097f7b3430dc88e8070cad5899"></a><!-- doxytag: member="Passenger::Session::getConnectPassword" ref="aeaf4f7097f7b3430dc88e8070cad5899" args="() const " -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">const string Passenger::Session::getConnectPassword </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td> const<code> [inline]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Returns this session's process's connect password. </p>
-<p>This password is guaranteed to be valid ASCII. </p>
-</div>
-</div>
-<a class="anchor" id="a7b8a632ebde11544a8ab98fde89954bb"></a><!-- doxytag: member="Passenger::Session::getSocketName" ref="a7b8a632ebde11544a8ab98fde89954bb" args="() const =0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual string Passenger::Session::getSocketName </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td> const<code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Returns the address of the socket that this session is served from. </p>
-<p>This can be a Unix socket filename or a TCP host:port string like "127.0.0.1:1234".</p>
-<dl class="post"><dt><b>Postcondition:</b></dt><dd>!result.empty() </dd></dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#a720e98b8dd246eeca004c8e625c0d4d3">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="ab8f084ab143d44f1a9ef8e8ccc841485"></a><!-- doxytag: member="Passenger::Session::getSocketType" ref="ab8f084ab143d44f1a9ef8e8ccc841485" args="() const =0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual string Passenger::Session::getSocketType </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td> const<code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Returns the type of the socket that this session is served from, e.g. </p>
-<p>"unix" indicating a Unix socket.</p>
-<dl class="post"><dt><b>Postcondition:</b></dt><dd>!result.empty() </dd></dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#a3a59997280d5f7fcaa901716cd8451a2">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="a949c7a46f4bb0c628730ded2041d2489"></a><!-- doxytag: member="Passenger::Session::getStream" ref="a949c7a46f4bb0c628730ded2041d2489" args="() const =0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual int Passenger::Session::getStream </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td> const<code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Returns this session's channel's file descriptor. </p>
-<p>This stream is full-duplex, and will be automatically closed upon Session's destruction, unless <a class="el" href="classPassenger_1_1Session.html#a75344fdfb3c693323877e32884efaa31" title="Discard the I/O channel&#39;s file descriptor, so that the destructor won&#39;t automatically...">discardStream()</a> is called.</p>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl class="return"><dt><b>Returns:</b></dt><dd>The file descriptor, or -1 if the I/O channel has already been closed or discarded. </dd></dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#aa3491d2151ba3b94c1b19a4f18bade6a">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="abbcfa3eb48d38dead20c0d32cab4850b"></a><!-- doxytag: member="Passenger::Session::initiate" ref="abbcfa3eb48d38dead20c0d32cab4850b" args="()=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::initiate </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Initiate the session by connecting to the associated process. </p>
-<p>A <a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> is not usable until it's initiated.</p>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#ac283db6faf2fcd1827baf3ebac276677">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="a2203d81e25fe5066aed351608deecf7b"></a><!-- doxytag: member="Passenger::Session::sendBodyBlock" ref="a2203d81e25fe5066aed351608deecf7b" args="(const char *block, unsigned int size)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::sendBodyBlock </td>
-          <td>(</td>
-          <td class="paramtype">const char *&nbsp;</td>
-          <td class="paramname"> <em>block</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">unsigned int&nbsp;</td>
-          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td><td><code> [inline, virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Send a chunk of HTTP request body data to the application. </p>
-<p>You can call this method as many times as is required to transfer the entire HTTP request body.</p>
-<p>This method must only be called after a <a class="el" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders()</a>, otherwise strange things may happen.</p>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>block</em>&nbsp;</td><td>A block of HTTP request body data to send. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The size, in bytes, of <code>block</code>. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a></em>&nbsp;</td><td>The I/O channel has already been closed or discarded. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong during writing. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-</div>
-</div>
-<a class="anchor" id="a8253d81e64adc0dc72b1dc65a5117aba"></a><!-- doxytag: member="Passenger::Session::sendHeaders" ref="a8253d81e64adc0dc72b1dc65a5117aba" args="(const StaticString &amp;headers)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::sendHeaders </td>
-          <td>(</td>
-          <td class="paramtype">const <a class="el" href="classPassenger_1_1StaticString.html">StaticString</a> &amp;&nbsp;</td>
-          <td class="paramname"> <em>headers</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [inline, virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Convenience shortcut for <a class="el" href="classPassenger_1_1Session.html#a8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders(const char *, unsigned int)</a>. </p>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>headers</em>&nbsp;</td><td>The headers </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a></em>&nbsp;</td><td>The I/O channel has already been closed or discarded. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong during writing. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-</div>
-</div>
-<a class="anchor" id="a8f8a39f78dd2672b00f1ff01e4d6d671"></a><!-- doxytag: member="Passenger::Session::sendHeaders" ref="a8f8a39f78dd2672b00f1ff01e4d6d671" args="(const char *headers, unsigned int size)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::sendHeaders </td>
-          <td>(</td>
-          <td class="paramtype">const char *&nbsp;</td>
-          <td class="paramname"> <em>headers</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">unsigned int&nbsp;</td>
-          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td><td><code> [inline, virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Send HTTP request headers to the application. </p>
-<p>The HTTP headers must be converted into CGI headers, and then encoded into a string that matches this grammar:</p>
-<div class="fragment"><pre class="fragment">
-	   headers ::= header*
-	   header ::= name NUL value NUL
-	   name ::= notnull+
-	   value ::= notnull+
-	   notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"
-	   NUL = "\x00"
-	   </pre></div><p>There must be a header with the name "PASSWORD_CONNECT_PASSWORD", and it must have the same value as the string returned by <a class="el" href="classPassenger_1_1Session.html#aeaf4f7097f7b3430dc88e8070cad5899" title="Returns this session&#39;s process&#39;s connect password.">getConnectPassword()</a>.</p>
-<p>This method should be the first one to be called during the lifetime of a <a class="el" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> object, otherwise strange things may happen.</p>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>headers</em>&nbsp;</td><td>The HTTP request headers, converted into CGI headers and encoded as a string, according to the description. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The size, in bytes, of <code>headers</code>. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd>headers != NULL </dd>
-<dd>
-<a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a></em>&nbsp;</td><td>The I/O channel has already been closed or discarded. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong during writing. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-</div>
-</div>
-<a class="anchor" id="a5accbd8f7cce66d0ef6695481fdaa39c"></a><!-- doxytag: member="Passenger::Session::setReaderTimeout" ref="a5accbd8f7cce66d0ef6695481fdaa39c" args="(unsigned int msec)=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::setReaderTimeout </td>
-          <td>(</td>
-          <td class="paramtype">unsigned int&nbsp;</td>
-          <td class="paramname"> <em>msec</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Set the timeout value for reading data from the I/O channel. </p>
-<p>If no data can be read within the timeout period, then the read call will fail with error EAGAIN or EWOULDBLOCK.</p>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd>The I/O channel hasn't been closed or discarded. </dd>
-<dd>
-<a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>msec</em>&nbsp;</td><td>The timeout, in milliseconds. If 0 is given, there will be no timeout. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Cannot set the timeout. </td></tr>
-  </table>
-  </dd>
-</dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#a960346d8c27ff1ae9017d753e41a159a">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="a21dd749c0c8d22f65c6a914ec2f97c94"></a><!-- doxytag: member="Passenger::Session::setWriterTimeout" ref="a21dd749c0c8d22f65c6a914ec2f97c94" args="(unsigned int msec)=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::setWriterTimeout </td>
-          <td>(</td>
-          <td class="paramtype">unsigned int&nbsp;</td>
-          <td class="paramname"> <em>msec</em></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Set the timeout value for writing data from the I/O channel. </p>
-<p>If no data can be written within the timeout period, then the write call will fail with error EAGAIN or EWOULDBLOCK.</p>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd>The I/O channel hasn't been closed or discarded. </dd>
-<dd>
-<a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Parameters:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>msec</em>&nbsp;</td><td>The timeout, in milliseconds. If 0 is given, there will be no timeout. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Cannot set the timeout. </td></tr>
-  </table>
-  </dd>
-</dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#abb51c323ac0e24011191862f6dec7a75">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="ac579d233ddc82542c336b2af1f40c4dd"></a><!-- doxytag: member="Passenger::Session::shutdownReader" ref="ac579d233ddc82542c336b2af1f40c4dd" args="()=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::shutdownReader </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Indicate that we don't want to read data anymore from the I/O channel. </p>
-<p>Calling this method after <a class="el" href="classPassenger_1_1Session.html#a7ab85388f15388cb8e65873d1ad310a5" title="Close the I/O stream.">closeStream()</a>/discardStream() is called will have no effect.</p>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#ac92d4d081d6145ba8d441c8cf88fae74">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<a class="anchor" id="a8263c568a8ac4567b33728d820cbd920"></a><!-- doxytag: member="Passenger::Session::shutdownWriter" ref="a8263c568a8ac4567b33728d820cbd920" args="()=0" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">virtual void Passenger::Session::shutdownWriter </td>
-          <td>(</td>
-          <td class="paramname"></td>
-          <td>&nbsp;)&nbsp;</td>
-          <td><code> [pure virtual]</code></td>
-        </tr>
-      </table>
-</div>
-<div class="memdoc">
-<p>Indicate that we don't want to write data anymore to the I/O channel. </p>
-<p>Calling this method after <a class="el" href="classPassenger_1_1Session.html#a7ab85388f15388cb8e65873d1ad310a5" title="Close the I/O stream.">closeStream()</a>/discardStream() is called will have no effect.</p>
-<dl class="pre"><dt><b>Precondition:</b></dt><dd><a class="el" href="classPassenger_1_1Session.html#abf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated()</a> </dd></dl>
-<dl><dt><b>Exceptions:</b></dt><dd>
-  <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>boost::thread_interrupted</em>&nbsp;</td><td></td></tr>
-  </table>
-  </dd>
-</dl>
-<p>Implemented in <a class="el" href="classPassenger_1_1StandardSession.html#a045a8f7f849c34086b0832fdba7a2915">Passenger::StandardSession</a>.</p>
-</div>
-</div>
-<hr/>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="Session_8h_source.html">Session.h</a></li>
-</ul>
-</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>