<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>fastcgi++: Fastcgipp::Protocol::EndRequest Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</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 List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceFastcgipp.html">Fastcgipp</a>::<a class="el" href="namespaceFastcgipp_1_1Protocol.html">Protocol</a>::<a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html">EndRequest</a> </div> </div> <div class="contents"> <h1>Fastcgipp::Protocol::EndRequest Class Reference</h1><!-- doxytag: class="Fastcgipp::Protocol::EndRequest" -->Data structure used as the body for FastCGI records with a RecordType of END_REQUEST. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>></code> <p> <p> <a href="classFastcgipp_1_1Protocol_1_1EndRequest-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#f0fc32baff5c36851ece565762e5379b">setAppStatus</a> (int status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the requests return value. <a href="#f0fc32baff5c36851ece565762e5379b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#401b78416caffe81aae73eabe201d9de">setProtocolStatus</a> (<a class="el" href="namespaceFastcgipp_1_1Protocol.html#c203447d57bec5f40123a6860c205064">ProtocolStatus</a> status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the reason for termination. <a href="#401b78416caffe81aae73eabe201d9de"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#2bc691fc7ff24cce79aec4b606340b47">appStatusB3</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return value most significant byte. <a href="#2bc691fc7ff24cce79aec4b606340b47"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#cd08b31c0c5da5003485fdeaa8720cef">appStatusB2</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return value second most significant byte. <a href="#cd08b31c0c5da5003485fdeaa8720cef"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#2651ceb9350246510343e56ea1337762">appStatusB1</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return value third most significant byte. <a href="#2651ceb9350246510343e56ea1337762"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#77d52f686ef9a63154cc7db7a55878ae">appStatusB0</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return value least significant byte. <a href="#77d52f686ef9a63154cc7db7a55878ae"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#c5464ce445ad2832edcfd18145cd454b">protocolStatus</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Requests Status. <a href="#c5464ce445ad2832edcfd18145cd454b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#25578fb99ab04a923a554c2f29e4e427">reserved</a> [3]</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Reseved for future use and body padding. <a href="#25578fb99ab04a923a554c2f29e4e427"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Data structure used as the body for FastCGI records with a RecordType of END_REQUEST. <p> This structure defines the body used in FastCGI END_REQUEST records. It can be casted to raw 8 byte blocks of data and transmitted as is. An END_REQUEST record is sent when this side wishes to terminate a request. This can be simply because it is complete or because of a problem. <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00300">300</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="f0fc32baff5c36851ece565762e5379b"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::setAppStatus" ref="f0fc32baff5c36851ece565762e5379b" args="(int status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Fastcgipp::Protocol::EndRequest::setAppStatus </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>status</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the requests return value. <p> This is an integer value representing what would otherwise be the return value in a normal CGI application.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>status</em> </td><td>The return value </td></tr> </table> </dl> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00310">310</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> <p>References <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#2bc691fc7ff24cce79aec4b606340b47">appStatusB3</a>, and <a class="el" href="namespaceFastcgipp_1_1Protocol.html#30a7ef0ce988dee1a15224a0d3261eda">Fastcgipp::Protocol::readBigEndian()</a>.</p> </div> </div><p> <a class="anchor" name="401b78416caffe81aae73eabe201d9de"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::setProtocolStatus" ref="401b78416caffe81aae73eabe201d9de" args="(ProtocolStatus status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Fastcgipp::Protocol::EndRequest::setProtocolStatus </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceFastcgipp_1_1Protocol.html#c203447d57bec5f40123a6860c205064">ProtocolStatus</a> </td> <td class="paramname"> <em>status</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the reason for termination. <p> This value is one of ProtocolStatus and represents the reason for termination.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>status</em> </td><td>The requests status </td></tr> </table> </dl> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00318">318</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> <p>References <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#c5464ce445ad2832edcfd18145cd454b">protocolStatus</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="2bc691fc7ff24cce79aec4b606340b47"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::appStatusB3" ref="2bc691fc7ff24cce79aec4b606340b47" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#2bc691fc7ff24cce79aec4b606340b47">Fastcgipp::Protocol::EndRequest::appStatusB3</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Return value most significant byte. <p> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00321">321</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> <p>Referenced by <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#f0fc32baff5c36851ece565762e5379b">setAppStatus()</a>.</p> </div> </div><p> <a class="anchor" name="cd08b31c0c5da5003485fdeaa8720cef"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::appStatusB2" ref="cd08b31c0c5da5003485fdeaa8720cef" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#cd08b31c0c5da5003485fdeaa8720cef">Fastcgipp::Protocol::EndRequest::appStatusB2</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Return value second most significant byte. <p> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00323">323</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> </div> </div><p> <a class="anchor" name="2651ceb9350246510343e56ea1337762"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::appStatusB1" ref="2651ceb9350246510343e56ea1337762" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#2651ceb9350246510343e56ea1337762">Fastcgipp::Protocol::EndRequest::appStatusB1</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Return value third most significant byte. <p> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00325">325</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> </div> </div><p> <a class="anchor" name="77d52f686ef9a63154cc7db7a55878ae"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::appStatusB0" ref="77d52f686ef9a63154cc7db7a55878ae" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#77d52f686ef9a63154cc7db7a55878ae">Fastcgipp::Protocol::EndRequest::appStatusB0</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Return value least significant byte. <p> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00327">327</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> </div> </div><p> <a class="anchor" name="c5464ce445ad2832edcfd18145cd454b"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::protocolStatus" ref="c5464ce445ad2832edcfd18145cd454b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#c5464ce445ad2832edcfd18145cd454b">Fastcgipp::Protocol::EndRequest::protocolStatus</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Requests Status. <p> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00329">329</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> <p>Referenced by <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#401b78416caffe81aae73eabe201d9de">setProtocolStatus()</a>.</p> </div> </div><p> <a class="anchor" name="25578fb99ab04a923a554c2f29e4e427"></a><!-- doxytag: member="Fastcgipp::Protocol::EndRequest::reserved" ref="25578fb99ab04a923a554c2f29e4e427" args="[3]" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t <a class="el" href="classFastcgipp_1_1Protocol_1_1EndRequest.html#25578fb99ab04a923a554c2f29e4e427">Fastcgipp::Protocol::EndRequest::reserved</a>[3]<code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Reseved for future use and body padding. <p> <p>Definition at line <a class="el" href="protocol_8hpp-source.html#l00331">331</a> of file <a class="el" href="protocol_8hpp-source.html">protocol.hpp</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="protocol_8hpp-source.html">protocol.hpp</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 16 15:17:48 2008 for fastcgi++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>