<!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::WtClient 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_1WtClient.html">WtClient</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::Http::WtClient 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::WtClient" --> <p>Support for a Wt web application client. <a href="classWt_1_1Http_1_1WtClient.html#details">More...</a></p> <p><code>#include <Wt/Http/WtClient></code></p> <p><a href="classWt_1_1Http_1_1WtClient-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1WtClient.html#ad924da5532738ae76afd94d315bd3177">ClientOption</a> { <a class="el" href="classWt_1_1Http_1_1WtClient.html#ad924da5532738ae76afd94d315bd3177a348bdea49937916509c191b178c09cf8">SupportsAjax</a> = 0x1 }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for client user-agent options. <a href="classWt_1_1Http_1_1WtClient.html#ad924da5532738ae76afd94d315bd3177">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Http_1_1WtClient.html#abfa3c9fffc988bb38149ddc321ebc44a">startWtSession</a> (const std::string &host, const std::string &port, const std::string &path, const std::string &query=std::string(), WFlags< <a class="el" href="classWt_1_1Http_1_1WtClient.html#ad924da5532738ae76afd94d315bd3177">ClientOption</a> > flags=SupportsAjax)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a Wt session. <a href="#abfa3c9fffc988bb38149ddc321ebc44a"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Support for a Wt web application client. </p> <dl class="note"><dt><b>Note:</b></dt><dd>This class provides a utility to bootstrap a Wt session, but does not deal with new developments related to the bootstrap procedure such as progressive bootstrap. </dd></dl> </div><hr/><h2>Member Enumeration Documentation</h2> <a class="anchor" id="ad924da5532738ae76afd94d315bd3177"></a><!-- doxytag: member="Wt::Http::WtClient::ClientOption" ref="ad924da5532738ae76afd94d315bd3177" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classWt_1_1Http_1_1WtClient.html#ad924da5532738ae76afd94d315bd3177">Wt::Http::WtClient::ClientOption</a></td> </tr> </table> </div> <div class="memdoc"> <p>Enumeration for client user-agent options. </p> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="ad924da5532738ae76afd94d315bd3177a348bdea49937916509c191b178c09cf8"></a><!-- doxytag: member="SupportsAjax" ref="ad924da5532738ae76afd94d315bd3177a348bdea49937916509c191b178c09cf8" args="" -->SupportsAjax</em> </td><td> <p>Flag that indicates supports for AJAX. </p> </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="abfa3c9fffc988bb38149ddc321ebc44a"></a><!-- doxytag: member="Wt::Http::WtClient::startWtSession" ref="abfa3c9fffc988bb38149ddc321ebc44a" args="(const std::string &host, const std::string &port, const std::string &path, const std::string &query=std::string(), WFlags< ClientOption > flags=SupportsAjax)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Wt::Http::WtClient::startWtSession </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>host</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>query</em> = <code>std::string()</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">WFlags< <a class="el" href="classWt_1_1Http_1_1WtClient.html#ad924da5532738ae76afd94d315bd3177">ClientOption</a> > </td> <td class="paramname"><em>flags</em> = <code>SupportsAjax</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Starts a Wt session. </p> <p>A Wt application uses a bootstrap procedure during which it collects information on user agent capabilities (unless the progressive bootstrap method is enabled). Therefore a session is not spawned after the first request, but only after these capabilities have been collected by a second request.</p> <p>This function starts a session on the specific <code>host</code>, <code>port</code>, <code>path</code>, and optional <code>query</code>. These correspond to the different parts of a url:</p> <p><code><a href="http://">http://</a></code><em>host</em><code>:</code><em>port</em>/<em>path</em><code>?</code><code>query</code>. </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>