<!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::Message 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_1Message.html">Message</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Http::Message 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::Message" -->
<p>An HTTP client message (request or response).
<a href="classWt_1_1Http_1_1Message.html#details">More...</a></p>
<p><code>#include <Wt/Http/Message></code></p>
<p><a href="classWt_1_1Http_1_1Message-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_1Message_1_1Header.html">Header</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An HTTP message header. <a href="classWt_1_1Http_1_1Message_1_1Header.html#details">More...</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#a5a55ee432496f398b3b20bb8f9703195">Message</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a5a55ee432496f398b3b20bb8f9703195"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#a75a34f09beb3093c789e09e205a455ea">Message</a> (std::vector< <a class="el" href="classWt_1_1Http_1_1Message_1_1Header.html">Header</a> > headers)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a75a34f09beb3093c789e09e205a455ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#ae6098f85d8f1eb832f74e0ff7620ec21">setStatus</a> (int status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the status code. <a href="#ae6098f85d8f1eb832f74e0ff7620ec21"></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_1Message.html#aa85a8128fb7c042df46c23212276947d">status</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the status code. <a href="#aa85a8128fb7c042df46c23212276947d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#afe89b9985a884a500266df9ce358f013">setHeader</a> (const std::string &name, const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a header value. <a href="#afe89b9985a884a500266df9ce358f013"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#af3ae185c24c499d08bf3475e594b1b2f">addHeader</a> (const std::string &name, const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a header value. <a href="#af3ae185c24c499d08bf3475e594b1b2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e7d32f496a1b97aa4776f0deffc197f"></a><!-- doxytag: member="Wt::Http::Message::headers" ref="a4e7d32f496a1b97aa4776f0deffc197f" args="() const " -->
const std::vector< <a class="el" href="classWt_1_1Http_1_1Message_1_1Header.html">Header</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#a4e7d32f496a1b97aa4776f0deffc197f">headers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the headers. <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_1Message.html#ae826dbd21cfdac36729be20847392750">getHeader</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a header value. <a href="#ae826dbd21cfdac36729be20847392750"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1Message.html#afeab67c20483f8862015a79b9f9fa8d6">addBodyText</a> (const std::string &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenates body text. <a href="#afeab67c20483f8862015a79b9f9fa8d6"></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_1Message.html#ac2bbe7354b6066adf7f96bcc6b8dcd8b">body</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An HTTP client message (request or response). </p>
<p>This class implements a message that is sent or received by the HTTP <a class="el" href="classWt_1_1Http_1_1Client.html" title="An HTTP client.">Client</a>.</p>
<p>It is not to be confused with <a class="el" href="classWt_1_1Http_1_1Request.html" title="A resource request.">Request</a> and <a class="el" href="classWt_1_1Http_1_1Response.html" title="A resource response.">Response</a>, which are involved in the web application server handling. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5a55ee432496f398b3b20bb8f9703195"></a><!-- doxytag: member="Wt::Http::Message::Message" ref="a5a55ee432496f398b3b20bb8f9703195" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Http::Message::Message </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>This creates an empty message, with an invalid status (-1), no headers and an empty body. </p>
</div>
</div>
<a class="anchor" id="a75a34f09beb3093c789e09e205a455ea"></a><!-- doxytag: member="Wt::Http::Message::Message" ref="a75a34f09beb3093c789e09e205a455ea" args="(std::vector< Header > headers)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Http::Message::Message </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="classWt_1_1Http_1_1Message_1_1Header.html">Header</a> > </td>
<td class="paramname"><em>headers</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>This creates an empty message, with an invalid status (-1), an empty body and the given headers. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afeab67c20483f8862015a79b9f9fa8d6"></a><!-- doxytag: member="Wt::Http::Message::addBodyText" ref="afeab67c20483f8862015a79b9f9fa8d6" args="(const std::string &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Http::Message::addBodyText </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Concatenates body text. </p>
<p>Adds the <code>text</code> to the message body. </p>
</div>
</div>
<a class="anchor" id="af3ae185c24c499d08bf3475e594b1b2f"></a><!-- doxytag: member="Wt::Http::Message::addHeader" ref="af3ae185c24c499d08bf3475e594b1b2f" args="(const std::string &name, const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Http::Message::addHeader </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a header value. </p>
<p>A header is added, even if a header with the same name already was present. This is allowed by HTTP only for certain headers (e.g. Set-Cookie).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Message.html#afe89b9985a884a500266df9ce358f013" title="Sets a header value.">setHeader()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac2bbe7354b6066adf7f96bcc6b8dcd8b"></a><!-- doxytag: member="Wt::Http::Message::body" ref="ac2bbe7354b6066adf7f96bcc6b8dcd8b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Http::Message::body </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the body text. </p>
</div>
</div>
<a class="anchor" id="ae826dbd21cfdac36729be20847392750"></a><!-- doxytag: member="Wt::Http::Message::getHeader" ref="ae826dbd21cfdac36729be20847392750" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string * Wt::Http::Message::getHeader </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 header value. </p>
<p>Returns 0 if no header with that name is found. </p>
</div>
</div>
<a class="anchor" id="afe89b9985a884a500266df9ce358f013"></a><!-- doxytag: member="Wt::Http::Message::setHeader" ref="afe89b9985a884a500266df9ce358f013" args="(const std::string &name, const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Http::Message::setHeader </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a header value. </p>
<p>If a header with that value was already defined, it is replaced with the new value. Otherwise, the header is added.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Http_1_1Message.html#af3ae185c24c499d08bf3475e594b1b2f" title="Adds a header value.">addHeader()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae6098f85d8f1eb832f74e0ff7620ec21"></a><!-- doxytag: member="Wt::Http::Message::setStatus" ref="ae6098f85d8f1eb832f74e0ff7620ec21" args="(int status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Http::Message::setStatus </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the status code. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This method is probably not useful to you, since for a request it is ignored, and for a response it is set by the client. </dd></dl>
</div>
</div>
<a class="anchor" id="aa85a8128fb7c042df46c23212276947d"></a><!-- doxytag: member="Wt::Http::Message::status" ref="aa85a8128fb7c042df46c23212276947d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::Http::Message::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the status code. </p>
<p>This returns the HTTP status code of a response message. Typical values are 200 (OK) or 404 (Not found). </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>
