<!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::CgiEnvironment 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_1CgiEnvironment.html">CgiEnvironment</a>
</div>
</div>
<div class="contents">
<h1>cgicc::CgiEnvironment Class Reference</h1><!-- doxytag: class="cgicc::CgiEnvironment" -->Class encapsulating the CGI runtime environment.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="CgiEnvironment_8h_source.html">cgicc/CgiEnvironment.h</a>></code>
<p>
<p>
<a href="classcgicc_1_1CgiEnvironment-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_1CgiEnvironment.html#e6df7bd5191cb5db0ba83a9ba464cdc3">CgiEnvironment</a> (<a class="el" href="classcgicc_1_1CgiInput.html">CgiInput</a> *input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read in the CGI environment passed to the CGI application by the server. <a href="#e6df7bd5191cb5db0ba83a9ba464cdc3"></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_1CgiEnvironment.html#5cd5b5a057184ca725122d4290c3632d">CgiEnvironment</a> (const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> &env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#5cd5b5a057184ca725122d4290c3632d"></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_1CgiEnvironment.html#8f7db9a9412141d0a4f470ba03c39ef5">~CgiEnvironment</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#8f7db9a9412141d0a4f470ba03c39ef5"></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_1CgiEnvironment.html#4f5faaa9966bef1406989964f0ea3a50">operator==</a> (const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> &env) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two CgiEnvironments for equality. <a href="#4f5faaa9966bef1406989964f0ea3a50"></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_1CgiEnvironment.html#657498c1dc62b84741190d476b938c83">operator!=</a> (const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> &env) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two CgiEnvironments for inequality. <a href="#657498c1dc62b84741190d476b938c83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1CgiEnvironment.html#969ff5a460e3088411f9eea7704a06b8">operator=</a> (const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> &env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign one <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to another. <a href="#969ff5a460e3088411f9eea7704a06b8"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Server Information</div></td></tr>
<tr><td colspan="2"><div class="groupText">Information on the server handling the HTTP/CGI request <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_1CgiEnvironment.html#9406c7666e6b5f3140c2c180406abd6c">getServerSoftware</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name and version of the HTTP server software. <a href="#9406c7666e6b5f3140c2c180406abd6c"></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_1CgiEnvironment.html#194db347a1495c945f2f02e77de36369">getServerName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hostname, DNS name or IP address of the HTTP server. <a href="#194db347a1495c945f2f02e77de36369"></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_1CgiEnvironment.html#123731bec6b09c97efbb6a762c23aaa0">getGatewayInterface</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name and version of the gateway interface. <a href="#123731bec6b09c97efbb6a762c23aaa0"></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_1CgiEnvironment.html#31f03a6bccb4ef18091fdc4ed88e1080">getServerProtocol</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name and revision of the protocol used for this request. <a href="#31f03a6bccb4ef18091fdc4ed88e1080"></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_1CgiEnvironment.html#62cb28728ef46bf996d42886e9820658">getServerPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the port number on the server to which this request was sent. <a href="#62cb28728ef46bf996d42886e9820658"></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_1CgiEnvironment.html#b158d687a41e5fceaf5ff054746fa0b8">usingHTTPS</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if this is a secure request. <a href="#b158d687a41e5fceaf5ff054746fa0b8"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">CGI Query Information</div></td></tr>
<tr><td colspan="2"><div class="groupText">Information specific to this CGI query <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_1CgiEnvironment.html#b1c2866b9935d31ff426f1b4c9c71e20">getCookies</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the HTTP cookies associated with this query, if any. <a href="#b1c2866b9935d31ff426f1b4c9c71e20"></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_1CgiEnvironment.html#0bd20edaba1315bedd0c0d24aa2a0aef">getCookieList</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a <code>vector</code> containing the HTTP cookies associated with this query. <a href="#0bd20edaba1315bedd0c0d24aa2a0aef"></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_1CgiEnvironment.html#8715ae7f2b3c256b0d5a4e6366c0227e">getRequestMethod</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the request method used for this query. <a href="#8715ae7f2b3c256b0d5a4e6366c0227e"></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_1CgiEnvironment.html#babc495d92a4ed5b262485c433f359ce">getPathInfo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the extra path information for this request, given by the client. <a href="#babc495d92a4ed5b262485c433f359ce"></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_1CgiEnvironment.html#5a058468f427f089e0ccbb7e90eb86a3">getPathTranslated</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the translated path information (virtual to physical mapping). <a href="#5a058468f427f089e0ccbb7e90eb86a3"></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_1CgiEnvironment.html#070e52f5d953fc70630ab0d6c857a3af">getScriptName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the full path to this CGI application. <a href="#070e52f5d953fc70630ab0d6c857a3af"></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_1CgiEnvironment.html#9bb50dc26be7c63f4373fe548e253e58">getQueryString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the query string for this request. <a href="#9bb50dc26be7c63f4373fe548e253e58"></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_1CgiEnvironment.html#5db5fd0b4fe5c642ba8d5260b7eb1ad8">getContentLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the data read from standard input, in chars. <a href="#5db5fd0b4fe5c642ba8d5260b7eb1ad8"></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_1CgiEnvironment.html#541b1a0caeeb4b16e274fc5cb63f2f90">getContentType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the content type of the submitted information. <a href="#541b1a0caeeb4b16e274fc5cb63f2f90"></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_1CgiEnvironment.html#58f61b5b80deb8519ef93fa3d58a33e8">getPostData</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the data passed to the CGI application via standard input. <a href="#58f61b5b80deb8519ef93fa3d58a33e8"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Server Specific Information</div></td></tr>
<tr><td colspan="2"><div class="groupText">Information dependent on the type of HTTP server in use <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_1CgiEnvironment.html#6410f58866cf1d0ba0bc8835b45c2661">getReferrer</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the URL of the page which called this CGI application. <a href="#6410f58866cf1d0ba0bc8835b45c2661"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Remote User Information</div></td></tr>
<tr><td colspan="2"><div class="groupText">Information about the user making the CGI request <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_1CgiEnvironment.html#106207f5afa94bde48531c35e1d5520d">getRemoteHost</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hostname of the remote machine making this request. <a href="#106207f5afa94bde48531c35e1d5520d"></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_1CgiEnvironment.html#76ced03bb493d83cbb24fb5bb38f916b">getRemoteAddr</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the IP address of the remote machine making this request. <a href="#76ced03bb493d83cbb24fb5bb38f916b"></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_1CgiEnvironment.html#d080a5a44f270bef398b08ea7f098c4c">getAuthType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the protocol-specific user authentication method used. <a href="#d080a5a44f270bef398b08ea7f098c4c"></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_1CgiEnvironment.html#d41263a397929489c44289d7d7ec6c37">getRemoteUser</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the authenticated remote user name. <a href="#d41263a397929489c44289d7d7ec6c37"></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_1CgiEnvironment.html#7364210900ee6cf3d14df39ae8852360">getRemoteIdent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the remote user name retrieved from the server. <a href="#7364210900ee6cf3d14df39ae8852360"></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_1CgiEnvironment.html#a4781973f885bd164aadc68fb1a3421d">getAccept</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the MIME data types accepted by the client's browser. <a href="#a4781973f885bd164aadc68fb1a3421d"></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_1CgiEnvironment.html#bfcefbb54e2ca56f063364537dd9ec6e">getUserAgent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the browser used for this CGI request. <a href="#bfcefbb54e2ca56f063364537dd9ec6e"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">ErrorDocument Handling</div></td></tr>
<tr><td colspan="2"><div class="groupText">For a tutorial on ErrorDocument handling, see <a href="http://hoohoo.ncsa.uiuc.edu/cgi/ErrorCGI.html">http://hoohoo.ncsa.uiuc.edu/cgi/ErrorCGI.html</a> <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_1CgiEnvironment.html#0d03fc2f5467ec3dae79ab9effe213ca">getRedirectRequest</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the redirect request. <a href="#0d03fc2f5467ec3dae79ab9effe213ca"></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_1CgiEnvironment.html#e132c4139b5e504e497c66e89a7f7fcc">getRedirectURL</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the redirect URL. <a href="#e132c4139b5e504e497c66e89a7f7fcc"></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_1CgiEnvironment.html#5571802fe19d32bfa4bcddda192fa57b">getRedirectStatus</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the redirect status. <a href="#5571802fe19d32bfa4bcddda192fa57b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Saving and Restoring</div></td></tr>
<tr><td colspan="2"><div class="groupText">These are implementation methods only <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_1CgiEnvironment.html#82e2e94da5071f7c3d8a1a67ac277d58">save</a> (const std::string &filename) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementation of save, for saving CGI environments. <a href="#82e2e94da5071f7c3d8a1a67ac277d58"></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_1CgiEnvironment.html#819281f00a4f413212b57b9922913220">restore</a> (const std::string &filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementation of restore, for restoring CGI environments. <a href="#819281f00a4f413212b57b9922913220"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb96a8237726d84210d29a1984c811dc"></a><!-- doxytag: member="cgicc::CgiEnvironment::Cgicc" ref="fb96a8237726d84210d29a1984c811dc" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Cgicc</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class encapsulating the CGI runtime environment.
<p>
The <code><a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a></code> class encapsulates the environment of the CGI application as described by the HTTP server. <code><a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a></code> contains the <code>GET</code> or <code>POST</code> data along with all environment variables set by the HTTP server specified in the CGI specification.
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00076">76</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e6df7bd5191cb5db0ba83a9ba464cdc3"></a><!-- doxytag: member="cgicc::CgiEnvironment::CgiEnvironment" ref="e6df7bd5191cb5db0ba83a9ba464cdc3" args="(CgiInput *input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::CgiEnvironment::CgiEnvironment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcgicc_1_1CgiInput.html">CgiInput</a> * </td>
<td class="paramname"> <em>input</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read in the CGI environment passed to the CGI application by the server.
<p>
This function is not usually called directly; instead, an object of type <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> is retrieved by calling the <code>getEnvironment()</code> method on <a class="el" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>. If you are using cgicc with FastCGI, you will need to pass a <code><a class="el" href="classcgicc_1_1CgiInput.html" title="Class that abstracts a data source.">CgiInput</a></code> subclass that cgicc will use to read input. If <code>input</code> is omitted, standard input and environment variables will be used. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>A <a class="el" href="classcgicc_1_1CgiInput.html" title="Class that abstracts a data source.">CgiInput</a> object to use for reading input </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcgicc_1_1Cgicc.html#61a5da400eca7803f33cddd23dca862e">Cgicc::getEnvironment</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="5cd5b5a057184ca725122d4290c3632d"></a><!-- doxytag: member="cgicc::CgiEnvironment::CgiEnvironment" ref="5cd5b5a057184ca725122d4290c3632d" args="(const CgiEnvironment &env)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::CgiEnvironment::CgiEnvironment </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> & </td>
<td class="paramname"> <em>env</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
Sets the values of this <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to those of <code>env</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>env</em> </td><td>The <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to copy. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00110">110</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f7db9a9412141d0a4f470ba03c39ef5"></a><!-- doxytag: member="cgicc::CgiEnvironment::~CgiEnvironment" ref="8f7db9a9412141d0a4f470ba03c39ef5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::CgiEnvironment::~CgiEnvironment </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
Delete this <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> object
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4781973f885bd164aadc68fb1a3421d"></a><!-- doxytag: member="cgicc::CgiEnvironment::getAccept" ref="a4781973f885bd164aadc68fb1a3421d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getAccept </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the MIME data types accepted by the client's browser.
<p>
For example <code>image/gif, image/x-xbitmap, image/jpeg, image/pjpeg</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The accepted data types </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00445">445</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d080a5a44f270bef398b08ea7f098c4c"></a><!-- doxytag: member="cgicc::CgiEnvironment::getAuthType" ref="d080a5a44f270bef398b08ea7f098c4c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getAuthType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the protocol-specific user authentication method used.
<p>
This is only applicable if the server supports user authentication, and the user has authenticated. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The authorization type </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00410">410</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5db5fd0b4fe5c642ba8d5260b7eb1ad8"></a><!-- doxytag: member="cgicc::CgiEnvironment::getContentLength" ref="5db5fd0b4fe5c642ba8d5260b7eb1ad8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long cgicc::CgiEnvironment::getContentLength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the length of the data read from standard input, in chars.
<p>
This is usually only valid for scripts called with the POST method. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The data length </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00328">328</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="541b1a0caeeb4b16e274fc5cb63f2f90"></a><!-- doxytag: member="cgicc::CgiEnvironment::getContentType" ref="541b1a0caeeb4b16e274fc5cb63f2f90" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getContentType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the content type of the submitted information.
<p>
For applications called via the GET method, this information is irrelevant. For applications called with the POST method, this is specifies the MIME type of the information, usually <code>application/x-www-form-urlencoded</code> or as specified by <a class="el" href="classcgicc_1_1CgiEnvironment.html#541b1a0caeeb4b16e274fc5cb63f2f90" title="Get the content type of the submitted information.">getContentType()</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The content type </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcgicc_1_1CgiEnvironment.html#541b1a0caeeb4b16e274fc5cb63f2f90" title="Get the content type of the submitted information.">getContentType</a> </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00343">343</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0bd20edaba1315bedd0c0d24aa2a0aef"></a><!-- doxytag: member="cgicc::CgiEnvironment::getCookieList" ref="0bd20edaba1315bedd0c0d24aa2a0aef" 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::CgiEnvironment::getCookieList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a <code>vector</code> containing the HTTP cookies associated with this query.
<p>
This vector may be empty <dl class="return" compact><dt><b>Returns:</b></dt><dd>A <code>vector</code> containing the HTTP cookies associated with this query </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcgicc_1_1HTTPCookie.html" title="An HTTP cookie.">HTTPCookie</a> </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00263">263</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
<p>Referenced by <a class="el" href="cardgame_8cpp_source.html#l01479">main()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b1c2866b9935d31ff426f1b4c9c71e20"></a><!-- doxytag: member="cgicc::CgiEnvironment::getCookies" ref="b1c2866b9935d31ff426f1b4c9c71e20" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getCookies </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the HTTP cookies associated with this query, if any.
<p>
The string returned by this method may contain multiple cookies; it is recommended to use the method <a class="el" href="classcgicc_1_1CgiEnvironment.html#0bd20edaba1315bedd0c0d24aa2a0aef" title="Get a vector containing the HTTP cookies associated with this query.">getCookieList()</a> instead, which returns a <code>vector<HTTPCookie></code>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The HTTP cookies </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcgicc_1_1CgiEnvironment.html#0bd20edaba1315bedd0c0d24aa2a0aef" title="Get a vector containing the HTTP cookies associated with this query.">getCookieList</a> </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00250">250</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="123731bec6b09c97efbb6a762c23aaa0"></a><!-- doxytag: member="cgicc::CgiEnvironment::getGatewayInterface" ref="123731bec6b09c97efbb6a762c23aaa0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getGatewayInterface </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 and version of the gateway interface.
<p>
This is usually <code>CGI/1.1</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name and version of the gateway interface </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00199">199</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="babc495d92a4ed5b262485c433f359ce"></a><!-- doxytag: member="cgicc::CgiEnvironment::getPathInfo" ref="babc495d92a4ed5b262485c433f359ce" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getPathInfo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the extra path information for this request, given by the client.
<p>
For example, in the string <code>foo.cgi/cgicc</code> the path information is <code><a class="el" href="namespacecgicc.html" title="The namespace containing the cgicc library.">cgicc</a></code>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The absolute path info </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00285">285</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5a058468f427f089e0ccbb7e90eb86a3"></a><!-- doxytag: member="cgicc::CgiEnvironment::getPathTranslated" ref="5a058468f427f089e0ccbb7e90eb86a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getPathTranslated </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the translated path information (virtual to physical mapping).
<p>
For example, <code>www.gnu.org</code> may be translated to <code>/htdocs/index</code>.html <dl class="return" compact><dt><b>Returns:</b></dt><dd>The translated path info </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00295">295</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="58f61b5b80deb8519ef93fa3d58a33e8"></a><!-- doxytag: member="cgicc::CgiEnvironment::getPostData" ref="58f61b5b80deb8519ef93fa3d58a33e8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getPostData </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 passed to the CGI application via standard input.
<p>
This data is of MIME type <code><a class="el" href="classcgicc_1_1CgiEnvironment.html#541b1a0caeeb4b16e274fc5cb63f2f90" title="Get the content type of the submitted information.">getContentType()</a></code>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The post data. </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00353">353</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9bb50dc26be7c63f4373fe548e253e58"></a><!-- doxytag: member="cgicc::CgiEnvironment::getQueryString" ref="9bb50dc26be7c63f4373fe548e253e58" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getQueryString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the query string for this request.
<p>
The query string follows the <code>?</code> in the URI which called this application. This is usually only valid for scripts called with the <code>GET</code> method. For example, in the string <code>foo.cgi</code>?cgicc=yes the query string is <code>cgicc=yes</code>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The query string </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00318">318</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0d03fc2f5467ec3dae79ab9effe213ca"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRedirectRequest" ref="0d03fc2f5467ec3dae79ab9effe213ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRedirectRequest </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the redirect request.
<p>
This will only be valid if you are using this script as a script to use in place of the default server messages. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The redirect request. </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00476">476</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5571802fe19d32bfa4bcddda192fa57b"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRedirectStatus" ref="5571802fe19d32bfa4bcddda192fa57b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRedirectStatus </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the redirect status.
<p>
This will only be valid if you are using this script as a script to use in place of the default server messages. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The redirect status. </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00499">499</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e132c4139b5e504e497c66e89a7f7fcc"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRedirectURL" ref="e132c4139b5e504e497c66e89a7f7fcc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRedirectURL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the redirect URL.
<p>
This will only be valid if you are using this script as a script to use in place of the default server messages. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The redirect URL. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a href="http://hoohoo.ncsa.uiuc.edu/docs/setup/srm/ErrorDocument.html">http://hoohoo.ncsa.uiuc.edu/docs/setup/srm/ErrorDocument.html</a> </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00488">488</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6410f58866cf1d0ba0bc8835b45c2661"></a><!-- doxytag: member="cgicc::CgiEnvironment::getReferrer" ref="6410f58866cf1d0ba0bc8835b45c2661" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getReferrer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the URL of the page which called this CGI application.
<p>
Depending on the HTTP server software, this value may not be set. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The URI which called this application. </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00371">371</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="76ced03bb493d83cbb24fb5bb38f916b"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRemoteAddr" ref="76ced03bb493d83cbb24fb5bb38f916b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRemoteAddr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the IP address of the remote machine making this request.
<p>
This is a standard IP address of the form <code>123.123.123.123</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The remote IP address </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00399">399</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="106207f5afa94bde48531c35e1d5520d"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRemoteHost" ref="106207f5afa94bde48531c35e1d5520d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRemoteHost </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the hostname of the remote machine making this request.
<p>
This may be either an IP address or a hostname <dl class="return" compact><dt><b>Returns:</b></dt><dd>The remote host </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00389">389</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7364210900ee6cf3d14df39ae8852360"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRemoteIdent" ref="7364210900ee6cf3d14df39ae8852360" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRemoteIdent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the remote user name retrieved from the server.
<p>
This is only applicable if the server supports RFC 931 identification. This variable should <em>only</em> be used for logging purposes. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The remote identification </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>RFC 1431 at <a href="http://info.internet.isi.edu:80/in-notes/rfc/files/rfc1413.txt">http://info.internet.isi.edu:80/in-notes/rfc/files/rfc1413.txt</a> </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00435">435</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d41263a397929489c44289d7d7ec6c37"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRemoteUser" ref="d41263a397929489c44289d7d7ec6c37" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRemoteUser </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the authenticated remote user name.
<p>
This is only applicable if the server supports user authentication, and the user has authenticated. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The remote username </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00421">421</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8715ae7f2b3c256b0d5a4e6366c0227e"></a><!-- doxytag: member="cgicc::CgiEnvironment::getRequestMethod" ref="8715ae7f2b3c256b0d5a4e6366c0227e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getRequestMethod </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the request method used for this query.
<p>
This is usually one of <code>GET</code> or <code>POST</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The request method </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00273">273</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="070e52f5d953fc70630ab0d6c857a3af"></a><!-- doxytag: member="cgicc::CgiEnvironment::getScriptName" ref="070e52f5d953fc70630ab0d6c857a3af" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getScriptName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the full path to this CGI application.
<p>
This is useful for self-referencing URIs <dl class="return" compact><dt><b>Returns:</b></dt><dd>The full path of this application </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00305">305</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="194db347a1495c945f2f02e77de36369"></a><!-- doxytag: member="cgicc::CgiEnvironment::getServerName" ref="194db347a1495c945f2f02e77de36369" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getServerName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the hostname, DNS name or IP address of the HTTP server.
<p>
This is <em>not</em> a URL, for example <code>www.gnu.org</code> (no leading <a href="http://">http://</a>) <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the server </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00189">189</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="62cb28728ef46bf996d42886e9820658"></a><!-- doxytag: member="cgicc::CgiEnvironment::getServerPort" ref="62cb28728ef46bf996d42886e9820658" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long cgicc::CgiEnvironment::getServerPort </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the port number on the server to which this request was sent.
<p>
This will usually be 80. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The port number </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00219">219</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="31f03a6bccb4ef18091fdc4ed88e1080"></a><!-- doxytag: member="cgicc::CgiEnvironment::getServerProtocol" ref="31f03a6bccb4ef18091fdc4ed88e1080" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getServerProtocol </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 and revision of the protocol used for this request.
<p>
This is usually <code>HTTP/1.0</code> or <code>HTTP/1.1</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The protocol in use </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00209">209</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9406c7666e6b5f3140c2c180406abd6c"></a><!-- doxytag: member="cgicc::CgiEnvironment::getServerSoftware" ref="9406c7666e6b5f3140c2c180406abd6c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getServerSoftware </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 and version of the HTTP server software.
<p>
For example, <code>Apache/1.3.4</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the server software </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00179">179</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bfcefbb54e2ca56f063364537dd9ec6e"></a><!-- doxytag: member="cgicc::CgiEnvironment::getUserAgent" ref="bfcefbb54e2ca56f063364537dd9ec6e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::CgiEnvironment::getUserAgent </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 the browser used for this CGI request.
<p>
For example <code>Mozilla/5.0 (X11; U; Linux 2.4.0 i686; en-US; 0.8.1) Gecko/20010421</code> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The browser name </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00456">456</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="657498c1dc62b84741190d476b938c83"></a><!-- doxytag: member="cgicc::CgiEnvironment::operator!=" ref="657498c1dc62b84741190d476b938c83" args="(const CgiEnvironment &env) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cgicc::CgiEnvironment::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> & </td>
<td class="paramname"> <em>env</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two CgiEnvironments for inequality.
<p>
CgiEnvironments are equal if they have the same environment variables. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to compare to this one. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>false</code> if the two CgiEnvironments are equal, <code>true</code> otherwise. </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00144">144</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="969ff5a460e3088411f9eea7704a06b8"></a><!-- doxytag: member="cgicc::CgiEnvironment::operator=" ref="969ff5a460e3088411f9eea7704a06b8" args="(const CgiEnvironment &env)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a>& cgicc::CgiEnvironment::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> & </td>
<td class="paramname"> <em>env</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign one <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to another.
<p>
Sets the environment variables in this <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to those of <code>env</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>env</em> </td><td>The <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to copy. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to this. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4f5faaa9966bef1406989964f0ea3a50"></a><!-- doxytag: member="cgicc::CgiEnvironment::operator==" ref="4f5faaa9966bef1406989964f0ea3a50" args="(const CgiEnvironment &env) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cgicc::CgiEnvironment::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1CgiEnvironment.html">CgiEnvironment</a> & </td>
<td class="paramname"> <em>env</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two CgiEnvironments for equality.
<p>
CgiEnvironments are equal if they have the same environment variables. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The <a class="el" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> to compare to this one. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the two CgiEnvironments are equal, <code>false</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="819281f00a4f413212b57b9922913220"></a><!-- doxytag: member="cgicc::CgiEnvironment::restore" ref="819281f00a4f413212b57b9922913220" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cgicc::CgiEnvironment::restore </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implementation of restore, for restoring CGI environments.
<p>
This is called internally by <a class="el" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The name of the file from which to restore </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="82e2e94da5071f7c3d8a1a67ac277d58"></a><!-- doxytag: member="cgicc::CgiEnvironment::save" ref="82e2e94da5071f7c3d8a1a67ac277d58" args="(const std::string &filename) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cgicc::CgiEnvironment::save </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implementation of save, for saving CGI environments.
<p>
This is called internally by <a class="el" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The name of the file to which to save </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b158d687a41e5fceaf5ff054746fa0b8"></a><!-- doxytag: member="cgicc::CgiEnvironment::usingHTTPS" ref="b158d687a41e5fceaf5ff054746fa0b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cgicc::CgiEnvironment::usingHTTPS </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 request.
<p>
A secure request is usually made using SSL via HTTPS <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if this connection is via https, <code>false</code> otherwise </dd></dl>
<p>Definition at line <a class="el" href="CgiEnvironment_8h_source.html#l00229">229</a> of file <a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CgiEnvironment_8h_source.html">CgiEnvironment.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:03:49 2009 for cgicc by
<a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.5.9
</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
82bf76c75b44c3e54c5dc9d8c4b11ab5
>
files
>
116
