<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Http::Request Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="modules.html"><span>Modules</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Http.html">Http</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Http_1_1Request.html">Request</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Http::Request Class Reference<div class="ingroups"><a class="el" href="group__http.html">HTTP protocol (Wt::Http)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Http::Request" -->
<p>A resource request.
<a href="classWt_1_1Http_1_1Request.html#details">More...</a></p>
<p><code>#include <Wt/Http/Request></code></p>
<p><a href="classWt_1_1Http_1_1Request-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request_1_1ByteRange.html">ByteRange</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A single byte range. <a href="classWt_1_1Http_1_1Request_1_1ByteRange.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request_1_1ByteRangeSpecifier.html">ByteRangeSpecifier</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A byte range specifier. <a href="classWt_1_1Http_1_1Request_1_1ByteRangeSpecifier.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef std::map< std::string, <br class="typebreak"/>
std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#af227a7cda2c6bc96554cbd3554c3004c">CookieMap</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cookie map type. <a href="#af227a7cda2c6bc96554cbd3554c3004c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceWt_1_1Http.html#a3420f95c8bfecf3d46e65920c765345a">ParameterMap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a25edf133c23a26cc166ab912e0b60b79">getParameterMap</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the query parameters. <a href="#a25edf133c23a26cc166ab912e0b60b79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceWt_1_1Http.html#a90602329029048d738daae9ba63e059a">UploadedFileMap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a3b4aaa1bf2debdf29306e7bb63d192fb">uploadedFiles</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns uploaded file parameters. <a href="#a3b4aaa1bf2debdf29306e7bb63d192fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceWt_1_1Http.html#ae1470e15e15eab123a19e4204f624598">ParameterValues</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a2820b2165bdcc337e05129d2c884bbdb">getParameterValues</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns all values for a query parameter. <a href="#a2820b2165bdcc337e05129d2c884bbdb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a9d2e071561f59e6be4a11ab22732b5a8">getParameter</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a query parameter value. <a href="#a9d2e071561f59e6be4a11ab22732b5a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Http_1_1UploadedFile.html">UploadedFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#af8f7b873e8d953cd5a1372fa3bddf52d">getUploadedFile</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an uploaded file. <a href="#af8f7b873e8d953cd5a1372fa3bddf52d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">::int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a17def18d77e8aa8a3c0db4594c992134">tooLarge</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a non-zero value that exceeded the maximum allowed request. <a href="#a17def18d77e8aa8a3c0db4594c992134"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Http_1_1ResponseContinuation.html">ResponseContinuation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a2d4f88961a222be846460a8238823ae0">continuation</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a continuation object. <a href="#a2d4f88961a222be846460a8238823ae0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a3ba38b20a0b3f7b985f7d3a3178f080d">serverName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the (public) server name. <a href="#a3ba38b20a0b3f7b985f7d3a3178f080d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a050ad797f0c9586113e654a9c8d27eb6">serverPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server port. <a href="#a050ad797f0c9586113e654a9c8d27eb6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a5e3962130a69fd22828f2bed3bc341a9">path</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the request path. <a href="#a5e3962130a69fd22828f2bed3bc341a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a38bbd6c56cd07bdf3abe254d17d83bff">pathInfo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the request path info. <a href="#a38bbd6c56cd07bdf3abe254d17d83bff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adef477ec6cf7b7f3e82254ab3338f3be"></a><!-- doxytag: member="Wt::Http::Request::queryString" ref="adef477ec6cf7b7f3e82254ab3338f3be" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#adef477ec6cf7b7f3e82254ab3338f3be">queryString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the request query string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a495633b89f99cd02cda65d3aad16eacc">urlScheme</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the url scheme used. <a href="#a495633b89f99cd02cda65d3aad16eacc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a768a65ceb3c0bf013b57c3de04b19041">in</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the input stream for parsing the body. <a href="#a768a65ceb3c0bf013b57c3de04b19041"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a588848625d3a7a968fec1a10cb435af3">contentType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the "Content Type" of the request body. <a href="#a588848625d3a7a968fec1a10cb435af3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#aa32f4e54c287098f5829fc49e6e71e31">contentLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the "Content Length" of the request body. <a href="#aa32f4e54c287098f5829fc49e6e71e31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a0201edb776325c8c30b86695561b5681">userAgent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user agent. <a href="#a0201edb776325c8c30b86695561b5681"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#aa9b24a6312b5e8598b54f1d98bf050eb">clientAddress</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the IP address of the client. <a href="#aa9b24a6312b5e8598b54f1d98bf050eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Http_1_1Request.html#af227a7cda2c6bc96554cbd3554c3004c">CookieMap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a1d0c62d32dcf5268526cedd7fdd84e4a">cookies</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the cookies. <a href="#a1d0c62d32dcf5268526cedd7fdd84e4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a786ac4c52ad6706ad5c285eff3f1e059">getCookieValue</a> (const std::string &cookieName) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a cookie value. <a href="#a786ac4c52ad6706ad5c285eff3f1e059"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#ade2596aa6802a63e21460094ea30a4d9">headerValue</a> (const std::string &field) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a header value. <a href="#ade2596aa6802a63e21460094ea30a4d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#ae76664f93462d9311ee671c93607e5ca">method</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the request method. <a href="#ae76664f93462d9311ee671c93607e5ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Http_1_1Request_1_1ByteRangeSpecifier.html">ByteRangeSpecifier</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Request.html#a0683f0a3d87ae10d7c947391fe60629a">getRanges</a> (::int64_t filesize) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the requested ranges as in the HTTP Range header. <a href="#a0683f0a3d87ae10d7c947391fe60629a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A resource request. </p>
<p>The request provides information of parameters, including uploaded files, that were present in a request to a <a class="el" href="classWt_1_1WResource.html" title="An object which can be rendered in the HTTP protocol.">WResource</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WResource.html#a3a740f8cc29e2e6e4e58defc9c88b8b6" title="Handles a request.">WResource::handleRequest()</a> </dd></dl>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="af227a7cda2c6bc96554cbd3554c3004c"></a><!-- doxytag: member="Wt::Http::Request::CookieMap" ref="af227a7cda2c6bc96554cbd3554c3004c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::map<std::string, std::string> <a class="el" href="classWt_1_1Http_1_1Request.html#af227a7cda2c6bc96554cbd3554c3004c">Wt::Http::Request::CookieMap</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cookie map type. </p>
<p>A map which associates a cookie name with a cookie value.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a1d0c62d32dcf5268526cedd7fdd84e4a" title="Returns the cookies.">cookies()</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa9b24a6312b5e8598b54f1d98bf050eb"></a><!-- doxytag: member="Wt::Http::Request::clientAddress" ref="aa9b24a6312b5e8598b54f1d98bf050eb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::clientAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the IP address of the client. </p>
<p>The (most likely) IP address of the client that is connected to this session.</p>
<p>This is taken to be the first public address that is given in the Client-IP header, or in the X-Forwarded-For header (in case the client is behind a proxy). If none of these headers is present, the remote socket IP address is used. </p>
</div>
</div>
<a class="anchor" id="aa32f4e54c287098f5829fc49e6e71e31"></a><!-- doxytag: member="Wt::Http::Request::contentLength" ref="aa32f4e54c287098f5829fc49e6e71e31" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::Http::Request::contentLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the "Content Length" of the request body. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a768a65ceb3c0bf013b57c3de04b19041" title="Returns the input stream for parsing the body.">in()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a588848625d3a7a968fec1a10cb435af3"></a><!-- doxytag: member="Wt::Http::Request::contentType" ref="a588848625d3a7a968fec1a10cb435af3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::contentType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the "Content Type" of the request body. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a768a65ceb3c0bf013b57c3de04b19041" title="Returns the input stream for parsing the body.">in()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2d4f88961a222be846460a8238823ae0"></a><!-- doxytag: member="Wt::Http::Request::continuation" ref="a2d4f88961a222be846460a8238823ae0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Http_1_1ResponseContinuation.html">ResponseContinuation</a>* Wt::Http::Request::continuation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a continuation object. </p>
<p>Returns a non-zero continuation object if the request is a continuation request for an earlier response for which a continuation was created.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Response.html#a5cb0800718188328fec17d3b84c85aab" title="Create a continuation object for this response.">Response::createContinuation()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1d0c62d32dcf5268526cedd7fdd84e4a"></a><!-- doxytag: member="Wt::Http::Request::cookies" ref="a1d0c62d32dcf5268526cedd7fdd84e4a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Http_1_1Request.html#af227a7cda2c6bc96554cbd3554c3004c">CookieMap</a>& Wt::Http::Request::cookies </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the cookies. </p>
<p>This returns all cookies set for this request.</p>
<p>Not all clients may support cookies or have cookies enabled.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a786ac4c52ad6706ad5c285eff3f1e059" title="Returns a cookie value.">getCookieValue()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a786ac4c52ad6706ad5c285eff3f1e059"></a><!-- doxytag: member="Wt::Http::Request::getCookieValue" ref="a786ac4c52ad6706ad5c285eff3f1e059" args="(const std::string &cookieName) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string * Wt::Http::Request::getCookieValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>cookieName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a cookie value. </p>
<p>Returns 0 if no value was set for the given cookie.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a1d0c62d32dcf5268526cedd7fdd84e4a" title="Returns the cookies.">cookies()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9d2e071561f59e6be4a11ab22732b5a8"></a><!-- doxytag: member="Wt::Http::Request::getParameter" ref="a9d2e071561f59e6be4a11ab22732b5a8" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string * Wt::Http::Request::getParameter </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a query parameter value. </p>
<p>Returns the first value defined for a parameter named <code>name</code> or <code>0</code> if the paramter does not exist. </p>
</div>
</div>
<a class="anchor" id="a25edf133c23a26cc166ab912e0b60b79"></a><!-- doxytag: member="Wt::Http::Request::getParameterMap" ref="a25edf133c23a26cc166ab912e0b60b79" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceWt_1_1Http.html#a3420f95c8bfecf3d46e65920c765345a">ParameterMap</a>& Wt::Http::Request::getParameterMap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the query parameters. </p>
<p>Returns parameters that were passed to the query, either inside the URL, or inside a POST request, excluding uploaded files.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a3b4aaa1bf2debdf29306e7bb63d192fb" title="Returns uploaded file parameters.">uploadedFiles()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2820b2165bdcc337e05129d2c884bbdb"></a><!-- doxytag: member="Wt::Http::Request::getParameterValues" ref="a2820b2165bdcc337e05129d2c884bbdb" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceWt_1_1Http.html#ae1470e15e15eab123a19e4204f624598">ParameterValues</a> & Wt::Http::Request::getParameterValues </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns all values for a query parameter. </p>
<p>Returns all values defined for a parameter named <code>name</code>. A single parameter may have multiple values, e.g. in the query string '?param=value1&param=value2'.</p>
<p>Returns an empty list if the query parameter does not exist. </p>
</div>
</div>
<a class="anchor" id="a0683f0a3d87ae10d7c947391fe60629a"></a><!-- doxytag: member="Wt::Http::Request::getRanges" ref="a0683f0a3d87ae10d7c947391fe60629a" args="(::int64_t filesize) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Http_1_1Request_1_1ByteRangeSpecifier.html">Request::ByteRangeSpecifier</a> Wt::Http::Request::getRanges </td>
<td>(</td>
<td class="paramtype">::int64_t </td>
<td class="paramname"><em>filesize</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the requested ranges as in the HTTP Range header. </p>
<p>The filesize is used to adapt the ranges to the actual file size as per rules of RFC 2616. If the file size is unknown, pass -1.</p>
<p>You should check if the ranges are satisfiable using <a class="el" href="classWt_1_1Http_1_1Request_1_1ByteRangeSpecifier.html#a8ef2be6043819c6f8fb427df74a7ff82" title="Returns whether the range is satisfiable.">ByteRangeSpecifier::isSatisfiable()</a>. </p>
</div>
</div>
<a class="anchor" id="af8f7b873e8d953cd5a1372fa3bddf52d"></a><!-- doxytag: member="Wt::Http::Request::getUploadedFile" ref="af8f7b873e8d953cd5a1372fa3bddf52d" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Http_1_1UploadedFile.html">UploadedFile</a> * Wt::Http::Request::getUploadedFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an uploaded file. </p>
<p>Returns the file uploaded for a parameter named <code>name</code> or <code>0</code> if the parameter does not contain does not exist or was not associated with a file input field. </p>
</div>
</div>
<a class="anchor" id="ade2596aa6802a63e21460094ea30a4d9"></a><!-- doxytag: member="Wt::Http::Request::headerValue" ref="ade2596aa6802a63e21460094ea30a4d9" args="(const std::string &field) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::headerValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>field</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a header value. </p>
<p>Returns a header value, or an empty string if the header was present.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Currently, the header name is case sensitive, although this should not be the case according to RFC2616 </dd></dl>
</div>
</div>
<a class="anchor" id="a768a65ceb3c0bf013b57c3de04b19041"></a><!-- doxytag: member="Wt::Http::Request::in" ref="a768a65ceb3c0bf013b57c3de04b19041" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::istream & Wt::Http::Request::in </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the input stream for parsing the body. </p>
<p>If the request was a POST with as <a class="el" href="classWt_1_1Http_1_1Request.html#a588848625d3a7a968fec1a10cb435af3" title="Returns the "Content Type" of the request body.">contentType()</a> "application/x-www-form-urlencoded" or "multipart/form-data", the input stream will already have been consumed by Wt's CGI parser, and made available as parameters in the request. </p>
</div>
</div>
<a class="anchor" id="ae76664f93462d9311ee671c93607e5ca"></a><!-- doxytag: member="Wt::Http::Request::method" ref="ae76664f93462d9311ee671c93607e5ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::method </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the request method. </p>
<p>Returns the HTTP request method ("GET", "POST", or other). </p>
</div>
</div>
<a class="anchor" id="a5e3962130a69fd22828f2bed3bc341a9"></a><!-- doxytag: member="Wt::Http::Request::path" ref="a5e3962130a69fd22828f2bed3bc341a9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::path </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the request path. </p>
<p>Returns the path at which this request was received (excluding internal path information): it is the path at which the application or resource is deployed.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a38bbd6c56cd07bdf3abe254d17d83bff" title="Returns the request path info.">pathInfo()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a38bbd6c56cd07bdf3abe254d17d83bff"></a><!-- doxytag: member="Wt::Http::Request::pathInfo" ref="a38bbd6c56cd07bdf3abe254d17d83bff" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::pathInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the request path info. </p>
<p>Returns additional path information internal to the <a class="el" href="classWt_1_1Http_1_1Request.html#a5e3962130a69fd22828f2bed3bc341a9" title="Returns the request path.">path()</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a38bbd6c56cd07bdf3abe254d17d83bff" title="Returns the request path info.">pathInfo()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3ba38b20a0b3f7b985f7d3a3178f080d"></a><!-- doxytag: member="Wt::Http::Request::serverName" ref="a3ba38b20a0b3f7b985f7d3a3178f080d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::serverName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the (public) server name. </p>
<p>Returns the public server name. This is the server name that is advertised to outside, which is determined in a OS specific way.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a050ad797f0c9586113e654a9c8d27eb6" title="Returns the server port.">serverPort()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a050ad797f0c9586113e654a9c8d27eb6"></a><!-- doxytag: member="Wt::Http::Request::serverPort" ref="a050ad797f0c9586113e654a9c8d27eb6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::serverPort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the server port. </p>
<p>Returns the server port number through which this request was received.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a3ba38b20a0b3f7b985f7d3a3178f080d" title="Returns the (public) server name.">serverName()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a17def18d77e8aa8a3c0db4594c992134"></a><!-- doxytag: member="Wt::Http::Request::tooLarge" ref="a17def18d77e8aa8a3c0db4594c992134" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t Wt::Http::Request::tooLarge </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a non-zero value that exceeded the maximum allowed request. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a5ebdb82053d80b17d5ac7affd8dc7fa2" title="Signal which indicates that too a large request was received.">WApplication::requestTooLarge</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3b4aaa1bf2debdf29306e7bb63d192fb"></a><!-- doxytag: member="Wt::Http::Request::uploadedFiles" ref="a3b4aaa1bf2debdf29306e7bb63d192fb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceWt_1_1Http.html#a90602329029048d738daae9ba63e059a">UploadedFileMap</a>& Wt::Http::Request::uploadedFiles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns uploaded file parameters. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Request.html#a25edf133c23a26cc166ab912e0b60b79" title="Returns the query parameters.">getParameterMap()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a495633b89f99cd02cda65d3aad16eacc"></a><!-- doxytag: member="Wt::Http::Request::urlScheme" ref="a495633b89f99cd02cda65d3aad16eacc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::urlScheme </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the url scheme used. </p>
<p>This is either <code>"http"</code> or <code>"https"</code> </p>
</div>
</div>
<a class="anchor" id="a0201edb776325c8c30b86695561b5681"></a><!-- doxytag: member="Wt::Http::Request::userAgent" ref="a0201edb776325c8c30b86695561b5681" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Request::userAgent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the user agent. </p>
<p>The user agent, as reported in the HTTP <code>User-Agent</code> field. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
