<!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::HTTPHeader 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_1HTTPHeader.html">HTTPHeader</a> </div> </div> <div class="contents"> <h1>cgicc::HTTPHeader Class Reference</h1><!-- doxytag: class="cgicc::HTTPHeader" --><!-- doxytag: inherits="cgicc::MStreamable" -->Abstract base class for all simple HTTP response headers. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="HTTPHeader_8h_source.html">cgicc/HTTPHeader.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for cgicc::HTTPHeader:</div> <div class="dynsection"> <p><center><img src="classcgicc_1_1HTTPHeader.png" usemap="#cgicc::HTTPHeader_map" border="0" alt=""></center> <map name="cgicc::HTTPHeader_map"> <area href="classcgicc_1_1MStreamable.html" alt="cgicc::MStreamable" shape="rect" coords="358,0,527,24"> <area href="classcgicc_1_1HTTPContentHeader.html" alt="cgicc::HTTPContentHeader" shape="rect" coords="179,112,348,136"> <area href="classcgicc_1_1HTTPRedirectHeader.html" alt="cgicc::HTTPRedirectHeader" shape="rect" coords="358,112,527,136"> <area href="classcgicc_1_1HTTPStatusHeader.html" alt="cgicc::HTTPStatusHeader" shape="rect" coords="537,112,706,136"> <area href="classcgicc_1_1HTTPHTMLHeader.html" alt="cgicc::HTTPHTMLHeader" shape="rect" coords="0,168,169,192"> <area href="classcgicc_1_1HTTPPlainHeader.html" alt="cgicc::HTTPPlainHeader" shape="rect" coords="179,168,348,192"> <area href="classcgicc_1_1HTTPXHTMLHeader.html" alt="cgicc::HTTPXHTMLHeader" shape="rect" coords="358,168,527,192"> </map> </div> <p> <a href="classcgicc_1_1HTTPHeader-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 colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr> <tr><td colspan="2"><div class="groupText"><br><br></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPHeader.html#69c56ab7952a93df391ba104d8716370">HTTPHeader</a> (const std::string &data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#69c56ab7952a93df391ba104d8716370"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPHeader.html#4896c2e3a612948c00a12b336cc259bc">HTTPHeader</a> (const <a class="el" href="classcgicc_1_1HTTPHeader.html">HTTPHeader</a> &header)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#4896c2e3a612948c00a12b336cc259bc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3c4ecff6b0142c79f97093afb88cbb3"></a><!-- doxytag: member="cgicc::HTTPHeader::~HTTPHeader" ref="b3c4ecff6b0142c79f97093afb88cbb3" args="()" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPHeader.html#b3c4ecff6b0142c79f97093afb88cbb3">~HTTPHeader</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr> <tr><td colspan="2"><div class="groupHeader">Cookie Management</div></td></tr> <tr><td colspan="2"><div class="groupText"><br><br></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcgicc_1_1HTTPHeader.html">HTTPHeader</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPHeader.html#649581c9f565be698b2315f985de732a">setCookie</a> (const <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> &cookie)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a cookie to go out with this <a class="el" href="classcgicc_1_1HTTPResponseHeader.html" title="Generic HTTP response header.">HTTPResponseHeader</a>. <a href="#649581c9f565be698b2315f985de732a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const std::vector< <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPHeader.html#4e1779a26a5999532537d94d8467c008">getCookies</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of all cookies associated with this header. <a href="#4e1779a26a5999532537d94d8467c008"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Accessor Method</div></td></tr> <tr><td colspan="2"><div class="groupText"><br><br></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPHeader.html#e1236ff233ff160dcfa49cf200ee6748">getData</a> () const </td></tr> <tr><td colspan="2"><div class="groupHeader">Subclass Methods</div></td></tr> <tr><td colspan="2"><div class="groupText"><br><br></div></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_1HTTPHeader.html#550657fcf3438c67af22c0a0c385a5af">render</a> (std::ostream &out) const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write this <a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">HTTPHeader</a> to a stream. <a href="#550657fcf3438c67af22c0a0c385a5af"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Abstract base class for all simple HTTP response headers. <p>Definition at line <a class="el" href="HTTPHeader_8h_source.html#l00052">52</a> of file <a class="el" href="HTTPHeader_8h_source.html">HTTPHeader.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="69c56ab7952a93df391ba104d8716370"></a><!-- doxytag: member="cgicc::HTTPHeader::HTTPHeader" ref="69c56ab7952a93df391ba104d8716370" args="(const std::string &data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPHeader::HTTPHeader </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>data</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. <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>data</em> </td><td>The header data. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="4896c2e3a612948c00a12b336cc259bc"></a><!-- doxytag: member="cgicc::HTTPHeader::HTTPHeader" ref="4896c2e3a612948c00a12b336cc259bc" args="(const HTTPHeader &header)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPHeader::HTTPHeader </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcgicc_1_1HTTPHeader.html">HTTPHeader</a> & </td> <td class="paramname"> <em>header</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Copy constructor. <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>header</em> </td><td>The <a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">HTTPHeader</a> to copy. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="4e1779a26a5999532537d94d8467c008"></a><!-- doxytag: member="cgicc::HTTPHeader::getCookies" ref="4e1779a26a5999532537d94d8467c008" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::vector<<a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a>>& cgicc::HTTPHeader::getCookies </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get a list of all cookies associated with this header. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>All the cookies associated with this header </dd></dl> <p>Definition at line <a class="el" href="HTTPHeader_8h_source.html#l00096">96</a> of file <a class="el" href="HTTPHeader_8h_source.html">HTTPHeader.h</a>.</p> </div> </div><p> <a class="anchor" name="e1236ff233ff160dcfa49cf200ee6748"></a><!-- doxytag: member="cgicc::HTTPHeader::getData" ref="e1236ff233ff160dcfa49cf200ee6748" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string cgicc::HTTPHeader::getData </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the data contained in this HTTP header. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The data contained in this header. </dd></dl> <p>Definition at line <a class="el" href="HTTPHeader_8h_source.html#l00110">110</a> of file <a class="el" href="HTTPHeader_8h_source.html">HTTPHeader.h</a>.</p> </div> </div><p> <a class="anchor" name="550657fcf3438c67af22c0a0c385a5af"></a><!-- doxytag: member="cgicc::HTTPHeader::render" ref="550657fcf3438c67af22c0a0c385a5af" args="(std::ostream &out) const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void cgicc::HTTPHeader::render </td> <td>(</td> <td class="paramtype">std::ostream & </td> <td class="paramname"> <em>out</em> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write this <a class="el" href="classcgicc_1_1HTTPHeader.html" title="Abstract base class for all simple HTTP response headers.">HTTPHeader</a> to a stream. <p> Subclasses must implement this function. <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_1MStreamable.html#6a4ae7e9c578b44eebf0f04341be74ab">cgicc::MStreamable</a>.</p> <p>Implemented in <a class="el" href="classcgicc_1_1HTTPContentHeader.html#6a602d4ed31758a6dc26b63dcacc1fa9">cgicc::HTTPContentHeader</a>, <a class="el" href="classcgicc_1_1HTTPRedirectHeader.html#3d72b2c1fe071916eec735084864a49e">cgicc::HTTPRedirectHeader</a>, and <a class="el" href="classcgicc_1_1HTTPStatusHeader.html#f6aa37dc11e627c0acef71dffcd5e157">cgicc::HTTPStatusHeader</a>.</p> </div> </div><p> <a class="anchor" name="649581c9f565be698b2315f985de732a"></a><!-- doxytag: member="cgicc::HTTPHeader::setCookie" ref="649581c9f565be698b2315f985de732a" args="(const HTTPCookie &cookie)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcgicc_1_1HTTPHeader.html">HTTPHeader</a>& cgicc::HTTPHeader::setCookie </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> & </td> <td class="paramname"> <em>cookie</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set a cookie to go out with this <a class="el" href="classcgicc_1_1HTTPResponseHeader.html" title="Generic HTTP response header.">HTTPResponseHeader</a>. <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>cookie</em> </td><td>The <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> to set </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPHeader_8h_source.html#l00088">88</a> of file <a class="el" href="HTTPHeader_8h_source.html">HTTPHeader.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="HTTPHeader_8h_source.html">HTTPHeader.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>