<!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.3 2002/03/09 18:30:37 sbooth Exp $ -->
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>cgicc::HTTPCookie class Reference</title>
<link rev="made" href="mailto:bug-cgicc@gnu.org" />
<link href="cgicc-doc.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.2.13.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>cgicc::HTTPCookie Class Reference</h1>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>
<p>Inheritance diagram for cgicc::HTTPCookie::
<p><center><img src="classcgicc_1_1HTTPCookie.gif" usemap="#cgicc::HTTPCookie_map" border="0"></center>
<map name="cgicc::HTTPCookie_map">
<area href="classcgicc_1_1MStreamable.html" alt="cgicc::MStreamable" shape="rect" coords="0,0,123,24">
</map>
<a href="classcgicc_1_1HTTPCookie-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z46_0">HTTPCookie</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default Constructor.</em> <a href="#z46_0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z46_1">HTTPCookie</a> (const std::string &name, const std::string &value)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a new <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a>.</em> <a href="#z46_1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z46_2">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> </td><td><font size=-1><em>Create a new fully-spefified <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a>.</em> <a href="#z46_2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z46_3">HTTPCookie</a> (const HTTPCookie &cookie)</td></tr>
<tr><td> </td><td><font size=-1><em>Copy constructor.</em> <a href="#z46_3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z46_4">~HTTPCookie</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#z46_4">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Overloaded Operators</div></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z47_0">operator==</a> (const HTTPCookie &cookie) const</td></tr>
<tr><td> </td><td><font size=-1><em>Compare two HTTPCookies for equality.</em> <a href="#z47_0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z47_1">operator!=</a> (const HTTPCookie &cookie) const</td></tr>
<tr><td> </td><td><font size=-1><em>Compare two HTTPCookies for inequality.</em> <a href="#z47_1">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessor Methods</div></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_0">getName</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the name of this cookie.</em> <a href="#z48_0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_1">getValue</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the value of this cookie.</em> <a href="#z48_1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_2">getComment</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the <a class="el" href="classcgicc_1_1comment.html">comment</a> of this cookie.</em> <a href="#z48_2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_3">getDomain</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the domain for which this cookie is valid.</em> <a href="#z48_3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned long </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_4">getMaxAge</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the lifetime of this cookie, in seconds.</em> <a href="#z48_4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_5">getPath</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the path of this cookie.</em> <a href="#z48_5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z48_6">isSecure</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Determine if this is a secure cookie.</em> <a href="#z48_6">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Mutator Methods</div></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_0">setName</a> (const std::string &name)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the name of this cookie.</em> <a href="#z49_0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_1">setValue</a> (const std::string &value)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the value of this cookie.</em> <a href="#z49_1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_2">setComment</a> (const std::string &<a class="el" href="classcgicc_1_1comment.html">comment</a>)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the <a class="el" href="classcgicc_1_1comment.html">comment</a> of this cookie.</em> <a href="#z49_2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_3">setDomain</a> (const std::string &domain)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the domain of this cookie.</em> <a href="#z49_3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_4">setMaxAge</a> (unsigned long maxAge)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the lifetime of this cookie, in seconds.</em> <a href="#z49_4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_5">setPath</a> (const std::string &path)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the path of this cookie.</em> <a href="#z49_5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z49_6">setSecure</a> (bool secure)</td></tr>
<tr><td> </td><td><font size=-1><em>Mark this cookie as secure or unsecure.</em> <a href="#z49_6">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Inherited Methods</div></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classcgicc_1_1HTTPCookie.html#z50_0">render</a> (std::ostream &out) const</td></tr>
<tr><td> </td><td><font size=-1><em>Write this object to a stream.</em> <a href="#z50_0">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An HTTP cookie.
<p>
<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">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> out << HTTPHTMLHeader().setCookie(<a class="code" href="classcgicc_1_1HTTPCookie.html#z46_0">HTTPCookie</a>(<font class="stringliteral">"count"</font>,<font class="stringliteral">"1"</font>));
</pre></div>
<p>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00056">56</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="z46_0" doxytag="cgicc::HTTPCookie::HTTPCookie"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> cgicc::HTTPCookie::HTTPCookie </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default Constructor.
<p>
<p>
Create a new, empty <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a>. </td>
</tr>
</table>
<a name="z46_1" doxytag="cgicc::HTTPCookie::HTTPCookie"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> cgicc::HTTPCookie::HTTPCookie </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a>.
<p>
<p>
This is the most commonly-used constructor. <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the cookie. </td></tr>
<tr><td valign=top><em>value</em> </td><td>
The value of the cookie. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="z46_2" doxytag="cgicc::HTTPCookie::HTTPCookie"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> cgicc::HTTPCookie::HTTPCookie </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>value</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>comment</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>domain</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>maxAge</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>path</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>secure</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new fully-spefified <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a>.
<p>
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the cookie. </td></tr>
<tr><td valign=top><em>value</em> </td><td>
The value of the cookie. </td></tr>
<tr><td valign=top><em><a class="el" href="classcgicc_1_1comment.html">comment</a></em> </td><td>
Any <a class="el" href="classcgicc_1_1comment.html">comment</a> associated with the cookie. </td></tr>
<tr><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><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><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><em>secure</em> </td><td>
Specifies whether this is a secure cookie. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="z46_3" doxytag="cgicc::HTTPCookie::HTTPCookie"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> cgicc::HTTPCookie::HTTPCookie </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const HTTPCookie & </td>
<td class="mdname1" valign="top" nowrap> <em>cookie</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy constructor.
<p>
<p>
Set the name, value, <a class="el" href="classcgicc_1_1comment.html">comment</a>, domain, age and path of this cookie to those of <code>cookie</code> <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cookie</em> </td><td>
The <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> to copy. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="z46_4" doxytag="cgicc::HTTPCookie::~HTTPCookie"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual cgicc::HTTPCookie::~HTTPCookie </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
<p>
Delete this <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="z48_2" doxytag="cgicc::HTTPCookie::getComment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std:: string cgicc::HTTPCookie::getComment </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the <a class="el" href="classcgicc_1_1comment.html">comment</a> of this cookie.
<p>
<p>
<dl compact><dt><b>
Returns: </b><dd>
The <a class="el" href="classcgicc_1_1comment.html">comment</a> of this cookie. </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>. </td>
</tr>
</table>
<a name="z48_3" doxytag="cgicc::HTTPCookie::getDomain"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std:: string cgicc::HTTPCookie::getDomain </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the domain for which this cookie is valid.
<p>
<p>
An empty string indicates the hostname of the server which generated the cookie response. <dl compact><dt><b>
Returns: </b><dd>
The domain of this cookie, or "" if none. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00197">197</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z48_4" doxytag="cgicc::HTTPCookie::getMaxAge"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned long cgicc::HTTPCookie::getMaxAge </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the lifetime of this cookie, in seconds.
<p>
<p>
<dl compact><dt><b>
Returns: </b><dd>
The lifetime of this cookie, or 0 if none. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00206">206</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z48_0" doxytag="cgicc::HTTPCookie::getName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std:: string cgicc::HTTPCookie::getName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the name of this cookie.
<p>
<p>
<dl compact><dt><b>
Returns: </b><dd>
The name of this cookie. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00168">168</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z48_5" doxytag="cgicc::HTTPCookie::getPath"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std:: string cgicc::HTTPCookie::getPath </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the path of this cookie.
<p>
<p>
This is the subset of URLS in a domain for which the cookie is valid, for example <code>/</code> <dl compact><dt><b>
Returns: </b><dd>
The path of this cookie, or "" if none. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00217">217</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z48_1" doxytag="cgicc::HTTPCookie::getValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std:: string cgicc::HTTPCookie::getValue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the value of this cookie.
<p>
<p>
<dl compact><dt><b>
Returns: </b><dd>
The value of this cookie. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00177">177</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z48_6" doxytag="cgicc::HTTPCookie::isSecure"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool cgicc::HTTPCookie::isSecure </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determine if this is a secure cookie.
<p>
<p>
<dl compact><dt><b>
Returns: </b><dd>
True if this cookie is secure, false if not. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00226">226</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z47_1" doxytag="cgicc::HTTPCookie::operator!="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool cgicc::HTTPCookie::operator!= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const HTTPCookie & </td>
<td class="mdname1" valign="top" nowrap> <em>cookie</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compare two HTTPCookies for inequality.
<p>
<p>
Two <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> objects are equal if their names, values, comments, domains, ages, and paths match. <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cookie</em> </td><td>
The <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> to compare to this one </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
false if the two HTTPCookies are equal, true otherwise. </dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00146">146</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z47_0" doxytag="cgicc::HTTPCookie::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool cgicc::HTTPCookie::operator== </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const HTTPCookie & </td>
<td class="mdname1" valign="top" nowrap> <em>cookie</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compare two HTTPCookies for equality.
<p>
<p>
Two <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> objects are equal if their names, values, comments, domains, ages, and paths match. <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cookie</em> </td><td>
The <a class="el" href="classcgicc_1_1HTTPCookie.html">HTTPCookie</a> to compare to this one </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
true if the two HTTPCookies are equal, false otherwise. </dl> </td>
</tr>
</table>
<a name="z50_0" doxytag="cgicc::HTTPCookie::render"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void cgicc::HTTPCookie::render </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::ostream & </td>
<td class="mdname1" valign="top" nowrap> <em>out</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Write this object to a stream.
<p>
<p>
Subclasses must implement this function. <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>out</em> </td><td>
The ostream to which to write. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classcgicc_1_1MStreamable.html#a2">cgicc::MStreamable</a>. </td>
</tr>
</table>
<a name="z49_2" doxytag="cgicc::HTTPCookie::setComment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setComment </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>comment</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the <a class="el" href="classcgicc_1_1comment.html">comment</a> of this cookie.
<p>
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="el" href="classcgicc_1_1comment.html">comment</a></em> </td><td>
The <a class="el" href="classcgicc_1_1comment.html">comment</a> of this cookie. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="HTTPCookie_8h-source.html#l00259">259</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z49_3" doxytag="cgicc::HTTPCookie::setDomain"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setDomain </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>domain</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the domain of this cookie.
<p>
<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><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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#l00271">271</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z49_4" doxytag="cgicc::HTTPCookie::setMaxAge"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setMaxAge </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned long </td>
<td class="mdname1" valign="top" nowrap> <em>maxAge</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the lifetime of this cookie, in seconds.
<p>
<p>
A value of <code>0</code> indicated the cookie expires immediately <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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#l00281">281</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z49_0" doxytag="cgicc::HTTPCookie::setName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the name of this cookie.
<p>
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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#l00241">241</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z49_5" doxytag="cgicc::HTTPCookie::setPath"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setPath </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>path</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the path of this cookie.
<p>
<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><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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#l00292">292</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z49_6" doxytag="cgicc::HTTPCookie::setSecure"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setSecure </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>secure</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Mark this cookie as secure or unsecure.
<p>
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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#l00301">301</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<a name="z49_1" doxytag="cgicc::HTTPCookie::setValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void cgicc::HTTPCookie::setValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the value of this cookie.
<p>
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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#l00250">250</a> of file <a class="el" href="HTTPCookie_8h-source.html">HTTPCookie.h</a>. </td>
</tr>
</table>
<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>
<!-- $Id: footer.html,v 1.3 2002/03/09 18:30:37 sbooth Exp $ -->
<hr>
<address><small>
GNU cgicc - A C++ class library for writing CGI applications<br />
Copyright © 1996 - 2002
<a href="mailto:sbooth@gnu.org">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 Sun Mar 17 16:40:58 2002 for cgicc by
<a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.2.13.1
</small></address>
</body>
</html>
