<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> <html lang="en" dir="LTR"> <head> <!-- $Id: header.html,v 1.5 2004/06/12 01:58:25 sbooth Exp $ --> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title>cgicc: cgicc::HTTPStatusHeader Class Reference</title> <link rev="made" href="mailto:bug-cgicc@gnu.org" /> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="cgicc-doc.css" rel="stylesheet" type="text/css" /> </head> <body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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="namespacecgicc.html">cgicc</a>::<a class="el" href="classcgicc_1_1HTTPStatusHeader.html">HTTPStatusHeader</a> </div> </div> <div class="contents"> <h1>cgicc::HTTPStatusHeader Class Reference</h1><!-- doxytag: class="cgicc::HTTPStatusHeader" --><!-- doxytag: inherits="cgicc::HTTPHeader" -->HTTP header to set a specific request status. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="HTTPStatusHeader_8h_source.html">cgicc/HTTPStatusHeader.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for cgicc::HTTPStatusHeader:</div> <div class="dynsection"> <p><center><img src="classcgicc_1_1HTTPStatusHeader.png" usemap="#cgicc::HTTPStatusHeader_map" border="0" alt=""></center> <map name="cgicc::HTTPStatusHeader_map"> <area href="classcgicc_1_1HTTPHeader.html" alt="cgicc::HTTPHeader" shape="rect" coords="0,56,156,80"> <area href="classcgicc_1_1MStreamable.html" alt="cgicc::MStreamable" shape="rect" coords="0,0,156,24"> </map> </div> <p> <a href="classcgicc_1_1HTTPStatusHeader-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPStatusHeader.html#d1d437dbdd96663f736610b4fbf427af">HTTPStatusHeader</a> (int status, const std::string &message)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new status header. <a href="#d1d437dbdd96663f736610b4fbf427af"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9aba1bd0355256460e4cf013ee9d955e"></a><!-- doxytag: member="cgicc::HTTPStatusHeader::~HTTPStatusHeader" ref="9aba1bd0355256460e4cf013ee9d955e" args="()" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPStatusHeader.html#9aba1bd0355256460e4cf013ee9d955e">~HTTPStatusHeader</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPStatusHeader.html#144d7ab9d478c2847bf9bce5db7d18fb">getStatusCode</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status code associated with this header. <a href="#144d7ab9d478c2847bf9bce5db7d18fb"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPStatusHeader.html#f6aa37dc11e627c0acef71dffcd5e157">render</a> (std::ostream &out) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write this <a class="el" href="classcgicc_1_1HTTPStatusHeader.html" title="HTTP header to set a specific request status.">HTTPStatusHeader</a> to a stream. <a href="#f6aa37dc11e627c0acef71dffcd5e157"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> HTTP header to set a specific request status. <p>Definition at line <a class="el" href="HTTPStatusHeader_8h_source.html#l00050">50</a> of file <a class="el" href="HTTPStatusHeader_8h_source.html">HTTPStatusHeader.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="d1d437dbdd96663f736610b4fbf427af"></a><!-- doxytag: member="cgicc::HTTPStatusHeader::HTTPStatusHeader" ref="d1d437dbdd96663f736610b4fbf427af" args="(int status, const std::string &message)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPStatusHeader::HTTPStatusHeader </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>status</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>message</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Create a new status header. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The 3-digit status code, for example 404. </td></tr> <tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>The message associated with the status code, for example "not found". </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="144d7ab9d478c2847bf9bce5db7d18fb"></a><!-- doxytag: member="cgicc::HTTPStatusHeader::getStatusCode" ref="144d7ab9d478c2847bf9bce5db7d18fb" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int cgicc::HTTPStatusHeader::getStatusCode </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the status code associated with this header. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The 3-digit status code of this header. </dd></dl> <p>Definition at line <a class="el" href="HTTPStatusHeader_8h_source.html#l00071">71</a> of file <a class="el" href="HTTPStatusHeader_8h_source.html">HTTPStatusHeader.h</a>.</p> </div> </div><p> <a class="anchor" name="f6aa37dc11e627c0acef71dffcd5e157"></a><!-- doxytag: member="cgicc::HTTPStatusHeader::render" ref="f6aa37dc11e627c0acef71dffcd5e157" args="(std::ostream &out) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void cgicc::HTTPStatusHeader::render </td> <td>(</td> <td class="paramtype">std::ostream & </td> <td class="paramname"> <em>out</em> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write this <a class="el" href="classcgicc_1_1HTTPStatusHeader.html" title="HTTP header to set a specific request status.">HTTPStatusHeader</a> to a stream. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>out</em> </td><td>The ostream to which to write. </td></tr> </table> </dl> <p>Implements <a class="el" href="classcgicc_1_1HTTPHeader.html#550657fcf3438c67af22c0a0c385a5af">cgicc::HTTPHeader</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="HTTPStatusHeader_8h_source.html">HTTPStatusHeader.h</a></ul> </div> <!-- $Id: footer.html,v 1.7 2004/06/12 01:58:25 sbooth Exp $ --> <hr> <address><small> <a href="http://www.cgicc.org">GNU cgicc</a> - A C++ class library for writing CGI applications<br /> Copyright © 1996 - 2004 <a href="mailto:sboothATgnuDOTorg">Stephen F. Booth</a><br /> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front Cover Texts, and with no Back-Cover Texts.<br /> Documentation generated Tue Jun 9 15:30:17 2009 for cgicc by <a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.5.9 </small></address> </body> </html>