<!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::HTTPCookie 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_1HTTPCookie.html">HTTPCookie</a> </div> </div> <div class="contents"> <h1>cgicc::HTTPCookie Class Reference</h1><!-- doxytag: class="cgicc::HTTPCookie" --><!-- doxytag: inherits="cgicc::MStreamable" -->An HTTP cookie. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="HTTPCookie_8h_source.html">cgicc/HTTPCookie.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for cgicc::HTTPCookie:</div> <div class="dynsection"> <p><center><img src="classcgicc_1_1HTTPCookie.png" usemap="#cgicc::HTTPCookie_map" border="0" alt=""></center> <map name="cgicc::HTTPCookie_map"> <area href="classcgicc_1_1MStreamable.html" alt="cgicc::MStreamable" shape="rect" coords="0,0,123,24"> </map> </div> <p> <a href="classcgicc_1_1HTTPCookie-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_1HTTPCookie.html#453c779f7c324f5f2a2d75a2f9244c67">HTTPCookie</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#453c779f7c324f5f2a2d75a2f9244c67"></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_1HTTPCookie.html#69a1f7a3e44eb1d4f1c41c8e6b166ce5">HTTPCookie</a> (const std::string &name, const std::string &value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a>. <a href="#69a1f7a3e44eb1d4f1c41c8e6b166ce5"></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_1HTTPCookie.html#6fc6cd6f3f9ed4953de4204412905799">HTTPCookie</a> (const std::string &name, const std::string &value, const std::string &<a class="el" href="classcgicc_1_1comment.html">comment</a>, const std::string &domain, unsigned long maxAge, const std::string &path, bool secure)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new fully-spefified <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a>. <a href="#6fc6cd6f3f9ed4953de4204412905799"></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_1HTTPCookie.html#ebdf1b8916e450bec00d81ccddce3222">HTTPCookie</a> (const <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> &cookie)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ebdf1b8916e450bec00d81ccddce3222"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#6650d18667b57c6823b0a9a339159142">~HTTPCookie</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#6650d18667b57c6823b0a9a339159142"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Overloaded Operators</div></td></tr> <tr><td colspan="2"><div class="groupText"><br><br></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#5d20a45ad707576efe377dd4354af74e">operator==</a> (const <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> &cookie) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two HTTPCookies for equality. <a href="#5d20a45ad707576efe377dd4354af74e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#3ccbfbdfaa774f2658bb2cabe3115c22">operator!=</a> (const <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> &cookie) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two HTTPCookies for inequality. <a href="#3ccbfbdfaa774f2658bb2cabe3115c22"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Accessor 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"><a class="anchor" name="b471fc725974bc5c363177fd6f710f98"></a><!-- doxytag: member="cgicc::HTTPCookie::remove" ref="b471fc725974bc5c363177fd6f710f98" args="()" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#b471fc725974bc5c363177fd6f710f98">remove</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Mark this cookie as secure or unsecure. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#2f2d800561d102522dc6fb559c004cc4">setRemoved</a> (bool removed)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Mark this cookie as secure or unsecure. <a href="#2f2d800561d102522dc6fb559c004cc4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#21973b62d4a56f6c05a1f726b1280528">isRemoved</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if this is a removed cookie. <a href="#21973b62d4a56f6c05a1f726b1280528"></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_1HTTPCookie.html#eb0406d714c243f9c97072e4d348c171">HTTPCookie</a> (const std::string &name, const std::string &domain, const std::string &path, bool secure)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new partially-spefified <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> for deletion. <a href="#eb0406d714c243f9c97072e4d348c171"></a><br></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_1HTTPCookie.html#97606fcdce9194405aacaa06543a9c40">getName</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this cookie. <a href="#97606fcdce9194405aacaa06543a9c40"></a><br></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_1HTTPCookie.html#1ebadf383bde8abead4f2b0a6453cb6d">getValue</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of this cookie. <a href="#1ebadf383bde8abead4f2b0a6453cb6d"></a><br></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_1HTTPCookie.html#c588da23d9236b46f3ccbbd9a5e3ebfe">getComment</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> of this cookie. <a href="#c588da23d9236b46f3ccbbd9a5e3ebfe"></a><br></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_1HTTPCookie.html#5364174a8d709c76b908efdf5fff161b">getDomain</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the domain for which this cookie is valid. <a href="#5364174a8d709c76b908efdf5fff161b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#6a0ef53ed1a7d7dda9129805e3f0cf68">getMaxAge</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the lifetime of this cookie, in seconds. <a href="#6a0ef53ed1a7d7dda9129805e3f0cf68"></a><br></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_1HTTPCookie.html#452a2cad8cd0b29d8776cf5c5c1be1d9">getPath</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the path of this cookie. <a href="#452a2cad8cd0b29d8776cf5c5c1be1d9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#91f15e25282aca381735d00084f256e9">isSecure</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if this is a secure cookie. <a href="#91f15e25282aca381735d00084f256e9"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Mutator 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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#08628a0283fafacf32374264c7060b2a">setName</a> (const std::string &name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of this cookie. <a href="#08628a0283fafacf32374264c7060b2a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#75e29f3aa018e4a00f5791fa099303da">setValue</a> (const std::string &value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of this cookie. <a href="#75e29f3aa018e4a00f5791fa099303da"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#983be4191f05a3abace522af2b0fec9d">setComment</a> (const std::string &<a class="el" href="classcgicc_1_1comment.html">comment</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> of this cookie. <a href="#983be4191f05a3abace522af2b0fec9d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#cfe38802d6df30d7d553bd5fb3b1ec2f">setDomain</a> (const std::string &domain)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the domain of this cookie. <a href="#cfe38802d6df30d7d553bd5fb3b1ec2f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#68edd328394c3b211dff11b879fe7e3a">setMaxAge</a> (unsigned long maxAge)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the lifetime of this cookie, in seconds. <a href="#68edd328394c3b211dff11b879fe7e3a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#0e8e27ad30522fa8c749a27acd6300b9">setPath</a> (const std::string &path)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the path of this cookie. <a href="#0e8e27ad30522fa8c749a27acd6300b9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1HTTPCookie.html#17dc01c86dffa694db661f5f45f5a69a">setSecure</a> (bool secure)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Mark this cookie as secure or unsecure. <a href="#17dc01c86dffa694db661f5f45f5a69a"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Inherited 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_1HTTPCookie.html#82f96b3972cb70cc51e389df3f27df4b">render</a> (std::ostream &out) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write this object to a stream. <a href="#82f96b3972cb70cc51e389df3f27df4b"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An HTTP cookie. <p> An HTTP cookie is a way to maintain state between stateless HTTP requests. HTTP cookies consist of name/value pairs, with optional comments, domains, and expiration dates. Usually, you will add one or more <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> objects to the HTTP headers your script is returning. For example, to set a cookie called <code>count</code> to <code>1</code> in a normal HTML document: <div class="fragment"><pre class="fragment"> out << HTTPHTMLHeader().setCookie(<a class="code" href="classcgicc_1_1HTTPCookie.html#453c779f7c324f5f2a2d75a2f9244c67" title="Default Constructor.">HTTPCookie</a>(<span class="stringliteral">"count"</span>,<span class="stringliteral">"1"</span>)); </pre></div> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00058">58</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="453c779f7c324f5f2a2d75a2f9244c67"></a><!-- doxytag: member="cgicc::HTTPCookie::HTTPCookie" ref="453c779f7c324f5f2a2d75a2f9244c67" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPCookie::HTTPCookie </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Default Constructor. <p> Create a new, empty <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a>. </div> </div><p> <a class="anchor" name="69a1f7a3e44eb1d4f1c41c8e6b166ce5"></a><!-- doxytag: member="cgicc::HTTPCookie::HTTPCookie" ref="69a1f7a3e44eb1d4f1c41c8e6b166ce5" args="(const std::string &name, const std::string &value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPCookie::HTTPCookie </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>value</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 <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a>. <p> This is the most commonly-used constructor. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the cookie. </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value of the cookie. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="6fc6cd6f3f9ed4953de4204412905799"></a><!-- doxytag: member="cgicc::HTTPCookie::HTTPCookie" ref="6fc6cd6f3f9ed4953de4204412905799" args="(const std::string &name, const std::string &value, const std::string &comment, const std::string &domain, unsigned long maxAge, const std::string &path, bool secure)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPCookie::HTTPCookie </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>comment</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>domain</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>maxAge</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>secure</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 fully-spefified <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</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>name</em> </td><td>The name of the cookie. </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value of the cookie. </td></tr> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a></em> </td><td>Any <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> associated with the cookie. </td></tr> <tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>The domain for which this cookie is valid- an empty string will use the hostname of the server which generated the cookie response. If specified, the domain <em>must</em> start with a period('.'). </td></tr> <tr><td valign="top"></td><td valign="top"><em>maxAge</em> </td><td>A number of seconds defining the lifetime of this cookie. A value of <code>0</code> indicates the cookie expires immediately. </td></tr> <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>The subset of URLS in a domain for which the cookie is valid, for example <code>/</code> </td></tr> <tr><td valign="top"></td><td valign="top"><em>secure</em> </td><td>Specifies whether this is a secure cookie. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="ebdf1b8916e450bec00d81ccddce3222"></a><!-- doxytag: member="cgicc::HTTPCookie::HTTPCookie" ref="ebdf1b8916e450bec00d81ccddce3222" args="(const HTTPCookie &cookie)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPCookie::HTTPCookie </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></td> </tr> </table> </div> <div class="memdoc"> <p> Copy constructor. <p> Set the name, value, <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a>, domain, age and path of this cookie to those of <code>cookie</code> <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 copy. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="6650d18667b57c6823b0a9a339159142"></a><!-- doxytag: member="cgicc::HTTPCookie::~HTTPCookie" ref="6650d18667b57c6823b0a9a339159142" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual cgicc::HTTPCookie::~HTTPCookie </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor. <p> Delete this <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> </div> </div><p> <a class="anchor" name="eb0406d714c243f9c97072e4d348c171"></a><!-- doxytag: member="cgicc::HTTPCookie::HTTPCookie" ref="eb0406d714c243f9c97072e4d348c171" args="(const std::string &name, const std::string &domain, const std::string &path, bool secure)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">cgicc::HTTPCookie::HTTPCookie </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>domain</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>secure</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 partially-spefified <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> for deletion. <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>name</em> </td><td>The name of the cookie. </td></tr> <tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>The domain for which this cookie is valid- an empty string will use the hostname of the server which generated the cookie response. If specified, the domain <em>must</em> start with a period('.'). </td></tr> <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>The subset of URLS in a domain for which the cookie is valid, for example <code>/</code> </td></tr> <tr><td valign="top"></td><td valign="top"><em>secure</em> </td><td>Specifies whether this is a secure cookie. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="c588da23d9236b46f3ccbbd9a5e3ebfe"></a><!-- doxytag: member="cgicc::HTTPCookie::getComment" ref="c588da23d9236b46f3ccbbd9a5e3ebfe" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string cgicc::HTTPCookie::getComment </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> of this cookie. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> of this cookie. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00229">229</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="5364174a8d709c76b908efdf5fff161b"></a><!-- doxytag: member="cgicc::HTTPCookie::getDomain" ref="5364174a8d709c76b908efdf5fff161b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string cgicc::HTTPCookie::getDomain </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the domain for which this cookie is valid. <p> An empty string indicates the hostname of the server which generated the cookie response. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The domain of this cookie, or "" if none. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00240">240</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="6a0ef53ed1a7d7dda9129805e3f0cf68"></a><!-- doxytag: member="cgicc::HTTPCookie::getMaxAge" ref="6a0ef53ed1a7d7dda9129805e3f0cf68" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long cgicc::HTTPCookie::getMaxAge </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the lifetime of this cookie, in seconds. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The lifetime of this cookie, or 0 if none. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00249">249</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="97606fcdce9194405aacaa06543a9c40"></a><!-- doxytag: member="cgicc::HTTPCookie::getName" ref="97606fcdce9194405aacaa06543a9c40" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string cgicc::HTTPCookie::getName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the name of this cookie. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of this cookie. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00211">211</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> <p>Referenced by <a class="el" href="cardgame_8cpp_source.html#l00214">CardGameTools::getNUMCookie()</a>.</p> </div> </div><p> <a class="anchor" name="452a2cad8cd0b29d8776cf5c5c1be1d9"></a><!-- doxytag: member="cgicc::HTTPCookie::getPath" ref="452a2cad8cd0b29d8776cf5c5c1be1d9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string cgicc::HTTPCookie::getPath </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the path of this cookie. <p> This is the subset of URLS in a domain for which the cookie is valid, for example <code>/</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The path of this cookie, or "" if none. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00260">260</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="1ebadf383bde8abead4f2b0a6453cb6d"></a><!-- doxytag: member="cgicc::HTTPCookie::getValue" ref="1ebadf383bde8abead4f2b0a6453cb6d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string cgicc::HTTPCookie::getValue </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the value of this cookie. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of this cookie. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00220">220</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> <p>Referenced by <a class="el" href="cardgame_8cpp_source.html#l00214">CardGameTools::getNUMCookie()</a>.</p> </div> </div><p> <a class="anchor" name="21973b62d4a56f6c05a1f726b1280528"></a><!-- doxytag: member="cgicc::HTTPCookie::isRemoved" ref="21973b62d4a56f6c05a1f726b1280528" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool cgicc::HTTPCookie::isRemoved </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Determine if this is a removed cookie. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this cookie is removed, false if not. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00186">186</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="91f15e25282aca381735d00084f256e9"></a><!-- doxytag: member="cgicc::HTTPCookie::isSecure" ref="91f15e25282aca381735d00084f256e9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool cgicc::HTTPCookie::isSecure </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Determine if this is a secure cookie. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this cookie is secure, false if not. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00269">269</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="3ccbfbdfaa774f2658bb2cabe3115c22"></a><!-- doxytag: member="cgicc::HTTPCookie::operator!=" ref="3ccbfbdfaa774f2658bb2cabe3115c22" args="(const HTTPCookie &cookie) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool cgicc::HTTPCookie::operator!= </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> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Compare two HTTPCookies for inequality. <p> Two <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> objects are equal if their names, values, comments, domains, ages, and paths match. <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 compare to this one </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>false if the two HTTPCookies are equal, true otherwise. </dd></dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00148">148</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="5d20a45ad707576efe377dd4354af74e"></a><!-- doxytag: member="cgicc::HTTPCookie::operator==" ref="5d20a45ad707576efe377dd4354af74e" args="(const HTTPCookie &cookie) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool cgicc::HTTPCookie::operator== </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> const</td> </tr> </table> </div> <div class="memdoc"> <p> Compare two HTTPCookies for equality. <p> Two <a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> objects are equal if their names, values, comments, domains, ages, and paths match. <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 compare to this one </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the two HTTPCookies are equal, false otherwise. </dd></dl> </div> </div><p> <a class="anchor" name="82f96b3972cb70cc51e389df3f27df4b"></a><!-- doxytag: member="cgicc::HTTPCookie::render" ref="82f96b3972cb70cc51e389df3f27df4b" args="(std::ostream &out) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void cgicc::HTTPCookie::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 object 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> </div> </div><p> <a class="anchor" name="983be4191f05a3abace522af2b0fec9d"></a><!-- doxytag: member="cgicc::HTTPCookie::setComment" ref="983be4191f05a3abace522af2b0fec9d" args="(const std::string &comment)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setComment </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>comment</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> of this cookie. <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><a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a></em> </td><td>The <a class="el" href="classcgicc_1_1comment.html" title="An HTML comment.">comment</a> of this cookie. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00302">302</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="cfe38802d6df30d7d553bd5fb3b1ec2f"></a><!-- doxytag: member="cgicc::HTTPCookie::setDomain" ref="cfe38802d6df30d7d553bd5fb3b1ec2f" args="(const std::string &domain)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setDomain </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>domain</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the domain of this cookie. <p> An empty string indicates the hostname of the server which generated the cookie response. If specified, the domain <em>must</em> start with a period('.'). <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>The domain of this cookie. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00314">314</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="68edd328394c3b211dff11b879fe7e3a"></a><!-- doxytag: member="cgicc::HTTPCookie::setMaxAge" ref="68edd328394c3b211dff11b879fe7e3a" args="(unsigned long maxAge)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setMaxAge </td> <td>(</td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>maxAge</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the lifetime of this cookie, in seconds. <p> A value of <code>0</code> indicated the cookie expires immediately <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>maxAge</em> </td><td>The lifetime of this cookie, in seconds. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00324">324</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="08628a0283fafacf32374264c7060b2a"></a><!-- doxytag: member="cgicc::HTTPCookie::setName" ref="08628a0283fafacf32374264c7060b2a" args="(const std::string &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setName </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the name of this cookie. <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>name</em> </td><td>The name of this cookie. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00284">284</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="0e8e27ad30522fa8c749a27acd6300b9"></a><!-- doxytag: member="cgicc::HTTPCookie::setPath" ref="0e8e27ad30522fa8c749a27acd6300b9" args="(const std::string &path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setPath </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>path</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the path of this cookie. <p> This is the subset of URLS in a domain for which the cookie is valid, for example <code>/</code> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>The path of this cookie. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00335">335</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="2f2d800561d102522dc6fb559c004cc4"></a><!-- doxytag: member="cgicc::HTTPCookie::setRemoved" ref="2f2d800561d102522dc6fb559c004cc4" args="(bool removed)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setRemoved </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>removed</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Mark this cookie as secure or unsecure. <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>removed</em> </td><td>Set removed status </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00178">178</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="17dc01c86dffa694db661f5f45f5a69a"></a><!-- doxytag: member="cgicc::HTTPCookie::setSecure" ref="17dc01c86dffa694db661f5f45f5a69a" args="(bool secure)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setSecure </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>secure</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Mark this cookie as secure or unsecure. <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>secure</em> </td><td>Whether this is a secure cookie. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00344">344</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <a class="anchor" name="75e29f3aa018e4a00f5791fa099303da"></a><!-- doxytag: member="cgicc::HTTPCookie::setValue" ref="75e29f3aa018e4a00f5791fa099303da" args="(const std::string &value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void cgicc::HTTPCookie::setValue </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>value</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the value of this cookie. <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>value</em> </td><td>The value of this cookie. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="HTTPCookie_8h_source.html#l00293">293</a> of file <a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="HTTPCookie_8h_source.html">HTTPCookie.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>