<!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::WServer 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="classWt_1_1WServer.html">WServer</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> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WServer Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WServer" -->
<p>A class encapsulating a web application server.
<a href="classWt_1_1WServer.html#details">More...</a></p>
<p><code>#include <Wt/WServer></code></p>
<p><a href="classWt_1_1WServer-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_1WServer_1_1Exception.html">Exception</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Server Exception class. <a href="classWt_1_1WServer_1_1Exception.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">WTCONNECTOR_API </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a4e347c4f853f527999c8c46c62d16f6b">WServer</a> (const std::string &wtApplicationPath=std::string(), const std::string &wtConfigurationFile=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new server instance. <a href="#a4e347c4f853f527999c8c46c62d16f6b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual WTCONNECTOR_API </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#ae7c9762cd7be550b0fcd71593af5fb37">~WServer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae7c9762cd7be550b0fcd71593af5fb37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a91dfcff8af7c2c42f26d3e4033cd9657">setIOService</a> (<a class="el" href="classWt_1_1WIOService.html">WIOService</a> &ioService)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the I/O service. <a href="#a91dfcff8af7c2c42f26d3e4033cd9657"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API <a class="el" href="classWt_1_1WIOService.html">WIOService</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a8e1945f6fc8013457037bc7280f5cfaa">ioService</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the I/O service. <a href="#a8e1945f6fc8013457037bc7280f5cfaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WTCONNECTOR_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a58852f006b4a233b49c332e819e3dce2">setServerConfiguration</a> (int argc, char *argv[], const std::string &serverConfigurationFile=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configures the HTTP(S) server or FastCGI process. <a href="#a58852f006b4a233b49c332e819e3dce2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a84f84652ccb139850adcf5ea75f50fa5">addEntryPoint</a> (<a class="el" href="namespaceWt.html#af4b6ed5fd28b4f5fa141b153c1107349">EntryPointType</a> type, ApplicationCreator callback, const std::string &path=std::string(), const std::string &favicon=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds an entry-point to a callback function to create a new application. <a href="#a84f84652ccb139850adcf5ea75f50fa5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a7b78b5e35d2dc3086faa54f82124cf38">addResource</a> (<a class="el" href="classWt_1_1WResource.html">WResource</a> *resource, const std::string &path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Binds a resource to a fixed path. <a href="#a7b78b5e35d2dc3086faa54f82124cf38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a9f5a82118198a1d2341fb89572fd8693">removeEntryPoint</a> (const std::string &path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an entry point. <a href="#a9f5a82118198a1d2341fb89572fd8693"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WTCONNECTOR_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a921af79ce0a6a35555409f2f844f8a72">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the server in the background. <a href="#a921af79ce0a6a35555409f2f844f8a72"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WTCONNECTOR_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a806538821ad3fe9b4b0b28c55fa160a0">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops the server. <a href="#a806538821ad3fe9b4b0b28c55fa160a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WTCONNECTOR_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#af15ec00e54dc985606ffa07f5f8f4c4d">isRunning</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the server is running. <a href="#af15ec00e54dc985606ffa07f5f8f4c4d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WTCONNECTOR_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#ad27189183523a6d718db4c7733cd29ab">resume</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resumes the server. <a href="#ad27189183523a6d718db4c7733cd29ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WTCONNECTOR_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a2084e677244b9ac790891a14d0201c0d">httpPort</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server HTTP port number. <a href="#a2084e677244b9ac790891a14d0201c0d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a6b0f98b3c7fcac1dd21bdf929e3b8428">appRoot</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the approot special property. <a href="#a6b0f98b3c7fcac1dd21bdf929e3b8428"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88">post</a> (const std::string &sessionId, const boost::function< void()> &function, const boost::function< void()> &fallBackFunction=boost::function< void()>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Posts a function to a session. <a href="#a6115cc9ad6ec28e55fb85e32a045df88"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a11cf397651bd2b470c65aa43b2a60271">readConfigurationProperty</a> (const std::string &name, std::string &value) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a configuration property. <a href="#a11cf397651bd2b470c65aa43b2a60271"></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 WT_API <a class="el" href="classWt_1_1WServer.html">WServer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a1673b8af0af972e983dc601f0492c283">instance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server instance. <a href="#a1673b8af0af972e983dc601f0492c283"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static WT_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a00d9eed95ef4519abfd139c76eda3ac9">waitForShutdown</a> (const char *restartWatchFile=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for a shutdown signal. <a href="#a00d9eed95ef4519abfd139c76eda3ac9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static WT_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#a9631ac0b2b08d3e848120ad2f52cde85">restart</a> (int argc, char **argv, char **envp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A utility method to restart. <a href="#a9631ac0b2b08d3e848120ad2f52cde85"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3">WRun</a> (int argc, char **argv, ApplicationCreator createApplication=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs the Wt application server. <a href="#abca6890dab44d87bd3af64705ac072d3"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class encapsulating a web application server. </p>
<p>This server class represents an instance of an application server.</p>
<p>It offers support for multiple application entry points and control over starting and stopping the server. This may be used as an alternative to using <a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun()</a> when you wish to support multiple application entry points, or for integrating a Wt (stand-alone httpd) server application into an existing application, with control over starting and stopping the server as appropriate.</p>
<p>As an example usage, consider the implementation of <a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun()</a>, which starts the server until a Ctrl-C is pressed or a termination signal has been received, or a restart is indicated using SIGHUP or a changed binary (argv[0]):</p>
<div class="fragment"><pre class="fragment"><span class="keywordtype">int</span> <a class="code" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[], ApplicationCreator createApplication)
{
<span class="keywordflow">try</span> {
<span class="comment">// use argv[0] as the application name to match a suitable entry</span>
<span class="comment">// in the Wt configuration file, and use the default configuration</span>
<span class="comment">// file (which defaults to /etc/wt/wt_config.xml unless the environment</span>
<span class="comment">// variable WT_CONFIG_XML is set)</span>
<a class="code" href="classWt_1_1WServer.html#a4e347c4f853f527999c8c46c62d16f6b" title="Creates a new server instance.">WServer</a> server(argv[0]);
<span class="comment">// WTHTTP_CONFIGURATION is e.g. "/etc/wt/wthttpd"</span>
server.setServerConfiguration(argc, argv, WTHTTP_CONFIGURATION);
<span class="comment">// add a single entry point, at the default location (as determined</span>
<span class="comment">// by the server configuration's deploy-path)</span>
server.addEntryPoint(<a class="code" href="namespaceWt.html#af4b6ed5fd28b4f5fa141b153c1107349a6688bf68bd3aeee4cca7e75a68dee7f1" title="Specifies a full-screen application.">Wt::Application</a>, createApplication);
<span class="keywordflow">if</span> (server.start()) {
<span class="keywordtype">int</span> sig = <a class="code" href="classWt_1_1WServer.html#a00d9eed95ef4519abfd139c76eda3ac9" title="Waits for a shutdown signal.">WServer::waitForShutdown</a>(argv[0]);
std::cerr << <span class="stringliteral">"Shutdown (signal = "</span> << sig << <span class="stringliteral">")"</span> << std::endl;
server.stop();
<span class="keywordflow">if</span> (sig == SIGHUP)
<a class="code" href="classWt_1_1WServer.html#a9631ac0b2b08d3e848120ad2f52cde85" title="A utility method to restart.">WServer::restart</a>(argc, argv, environ);
}
} <span class="keywordflow">catch</span> (WServer::Exception& e) {
std::cerr << e.what() << <span class="stringliteral">"\n"</span>;
<span class="keywordflow">return</span> 1;
} <span class="keywordflow">catch</span> (std::exception& e) {
std::cerr << <span class="stringliteral">"exception: "</span> << e.what() << <span class="stringliteral">"\n"</span>;
<span class="keywordflow">return</span> 1;
}
}
</pre></div> </div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4e347c4f853f527999c8c46c62d16f6b"></a><!-- doxytag: member="Wt::WServer::WServer" ref="a4e347c4f853f527999c8c46c62d16f6b" args="(const std::string &wtApplicationPath=std::string(), const std::string &wtConfigurationFile=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WServer::WServer </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>wtApplicationPath</em> = <code>std::string()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>wtConfigurationFile</em> = <code>std::string()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new server instance. </p>
<p>The <code>wtApplicationPath</code> is used to match specific application-settings in the Wt configuration file. If no specific match could be found, the general settings are used (corresponding to the '*' selector).</p>
<p>The Wt application configuration is read from the <code>wtConfigurationFile</code>. If empty, this defaults to the value configured at build time.</p>
<p>For more information on configuring Wt applications, see <a class="el" href="overview.html#configuration_sec">Configuration</a>.</p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classWt_1_1WServer_1_1Exception.html" title="Server Exception class.">Exception</a></td><td>: indicates a configuration problem.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a58852f006b4a233b49c332e819e3dce2" title="Configures the HTTP(S) server or FastCGI process.">setServerConfiguration()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae7c9762cd7be550b0fcd71593af5fb37"></a><!-- doxytag: member="Wt::WServer::~WServer" ref="ae7c9762cd7be550b0fcd71593af5fb37" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WServer::~WServer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>If the server was still running, it is stopped first by calling <a class="el" href="classWt_1_1WServer.html#a806538821ad3fe9b4b0b28c55fa160a0" title="Stops the server.">stop()</a>. It is probably safer to call <a class="el" href="classWt_1_1WServer.html#a806538821ad3fe9b4b0b28c55fa160a0" title="Stops the server.">stop()</a> first yourself, since this allows exceptions to be caught.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#af15ec00e54dc985606ffa07f5f8f4c4d" title="Returns whether the server is running.">isRunning()</a>, <a class="el" href="classWt_1_1WServer.html#a806538821ad3fe9b4b0b28c55fa160a0" title="Stops the server.">stop()</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a84f84652ccb139850adcf5ea75f50fa5"></a><!-- doxytag: member="Wt::WServer::addEntryPoint" ref="a84f84652ccb139850adcf5ea75f50fa5" args="(EntryPointType type, ApplicationCreator callback, const std::string &path=std::string(), const std::string &favicon=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WServer::addEntryPoint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#af4b6ed5fd28b4f5fa141b153c1107349">EntryPointType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ApplicationCreator </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em> = <code>std::string()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>favicon</em> = <code>std::string()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds an entry-point to a callback function to create a new application. </p>
<p>The <code>path</code> is the local URL at which the application is deployed: when a user visits this URL, the callback will be called to create a new application. If empty, the URL is inferred from the server configuration's deploy-path (see also <a class="el" href="overview.html#config_wthttpd">Built-in httpd configuration</a>).</p>
<p>The path must start with a '/'.</p>
<p>The optional <code>favicon</code> is a URL path (which should not contain the host part!) to a favicon, which is the icon displayed in the browser for your application. Alternatively, you may specify a favicon using the "favicon" property in the configuration file (see als <a class="el" href="overview.html#config_general">Application</a> settings (wt_config.xml)").</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a9f5a82118198a1d2341fb89572fd8693" title="Removes an entry point.">removeEntryPoint()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7b78b5e35d2dc3086faa54f82124cf38"></a><!-- doxytag: member="Wt::WServer::addResource" ref="a7b78b5e35d2dc3086faa54f82124cf38" args="(WResource *resource, const std::string &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WServer::addResource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WResource.html">WResource</a> * </td>
<td class="paramname"><em>resource</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binds a resource to a fixed path. </p>
<p>Resources may either be private to a single session or public. Use this method to add a public resource with a fixed path.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a9f5a82118198a1d2341fb89572fd8693" title="Removes an entry point.">removeEntryPoint()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6b0f98b3c7fcac1dd21bdf929e3b8428"></a><!-- doxytag: member="Wt::WServer::appRoot" ref="a6b0f98b3c7fcac1dd21bdf929e3b8428" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WServer::appRoot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the approot special property. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a88b082dadadd3fb7dbe10887e7d89c91" title="Returns the appRoot special property.">WApplication::appRoot()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2084e677244b9ac790891a14d0201c0d"></a><!-- doxytag: member="Wt::WServer::httpPort" ref="a2084e677244b9ac790891a14d0201c0d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WTCONNECTOR_API int Wt::WServer::httpPort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the server HTTP port number. </p>
<p>Returns -1 if the port is not known (i.e. because the connector is not aware of how the http server is configured). </p>
</div>
</div>
<a class="anchor" id="a1673b8af0af972e983dc601f0492c283"></a><!-- doxytag: member="Wt::WServer::instance" ref="a1673b8af0af972e983dc601f0492c283" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static WT_API <a class="el" href="classWt_1_1WServer.html">WServer</a>* Wt::WServer::instance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the server instance. </p>
<p>Returns the single server instance. This may be useful when using <a class="el" href="classWt_1_1WServer.html#abca6890dab44d87bd3af64705ac072d3" title="Runs the Wt application server.">WRun()</a>, which does not provide direct access to the instantiated server, but still you want to use functions like <a class="el" href="classWt_1_1WServer.html#a6115cc9ad6ec28e55fb85e32a045df88" title="Posts a function to a session.">post()</a>.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>When instantiating multiple servers, this will simply return the last instance. You probably want to avoid this function then. </dd></dl>
</div>
</div>
<a class="anchor" id="a8e1945f6fc8013457037bc7280f5cfaa"></a><!-- doxytag: member="Wt::WServer::ioService" ref="a8e1945f6fc8013457037bc7280f5cfaa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WIOService.html">WIOService</a> & Wt::WServer::ioService </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the I/O service. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a91dfcff8af7c2c42f26d3e4033cd9657" title="Sets the I/O service.">setIOService()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af15ec00e54dc985606ffa07f5f8f4c4d"></a><!-- doxytag: member="Wt::WServer::isRunning" ref="af15ec00e54dc985606ffa07f5f8f4c4d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WTCONNECTOR_API bool Wt::WServer::isRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the server is running. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a921af79ce0a6a35555409f2f844f8a72" title="Starts the server in the background.">start()</a>, <a class="el" href="classWt_1_1WServer.html#a806538821ad3fe9b4b0b28c55fa160a0" title="Stops the server.">stop()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6115cc9ad6ec28e55fb85e32a045df88"></a><!-- doxytag: member="Wt::WServer::post" ref="a6115cc9ad6ec28e55fb85e32a045df88" args="(const std::string &sessionId, const boost::function< void()> &function, const boost::function< void()> &fallBackFunction=boost::function< void()>())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WServer::post </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>sessionId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const boost::function< void()> & </td>
<td class="paramname"><em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const boost::function< void()> & </td>
<td class="paramname"><em>fallBackFunction</em> = <code>boost::function<void ()>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Posts a function to a session. </p>
<p>This is a thread-safe method to post a particular event (implemented as a function object) to be run within the context of a session, identified by its <a class="el" href="classWt_1_1WApplication.html#ab55c625a3197fec416544be8ad1529af" title="Returns the unique identifier for the current session.">WApplication::sessionId()</a>. The method will safely handle the case where the session is being terminated, and the session lock will be taken to execute the function in the context of the session (with <a class="el" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">WApplication::instance()</a> pointing to the correct application), just as with a request initiated by the browser. You will typically also want to push the changes to the client using server-initiated updates (<a class="el" href="classWt_1_1WApplication.html#a51f50e0641a6d702a7c6ab7f8dd5946a" title="Propagates server-initiated updates.">WApplication::triggerUpdate()</a>).</p>
<p>The method returns immediately, and the function will be run within the thread-pool that handles incoming web requests. In this way, it avoids dead-lock scenarios.</p>
<p>If a <code>fallbackFunction</code> is specified then in case the session is dead, it is called instead.</p>
<p>This provides a good alternative to grabbing the update lock of an application to directly push changes to a session out of its event loop.</p>
<p>Note that if you post an event to a method of a widget (or other object), it may still be that the targeted object has been deleted, if the life-time of that object is not the same as the life-time of the application. It may be useful to protect yourself from this by using <a class="el" href="classWt_1_1WApplication.html#aae1c2ee7c4dd469eb83299524ac0e7ee" title="Protects a function against deletion of the target object.">WApplication::bind()</a>. </p>
</div>
</div>
<a class="anchor" id="a11cf397651bd2b470c65aa43b2a60271"></a><!-- doxytag: member="Wt::WServer::readConfigurationProperty" ref="a11cf397651bd2b470c65aa43b2a60271" args="(const std::string &name, std::string &value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WServer::readConfigurationProperty </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">std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads a configuration property. </p>
<p>As properties are unique to an executable location, they are defined from the moment that <a class="el" href="classWt_1_1WServer.html#a58852f006b4a233b49c332e819e3dce2" title="Configures the HTTP(S) server or FastCGI process.">setServerConfiguration()</a> is invoked. Use this method to access configuration properties outside of an active session, e.g. from within the main() function.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#ac0f5599ed35eb159fa6912aa0ff3c75c" title="Reads a configuration property.">WApplication::readConfigurationProperty()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9f5a82118198a1d2341fb89572fd8693"></a><!-- doxytag: member="Wt::WServer::removeEntryPoint" ref="a9f5a82118198a1d2341fb89572fd8693" args="(const std::string &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WServer::removeEntryPoint </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes an entry point. </p>
<p>Use this method to remove an entry point or static resource.</p>
<p>In a multi-threaded environment, this may only be done when the server is not running.</p>
<p>When a resource has been bound to the path, the resource will not be deleted.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#a84f84652ccb139850adcf5ea75f50fa5" title="Binds an entry-point to a callback function to create a new application.">addEntryPoint()</a>, <a class="el" href="classWt_1_1WServer.html#a7b78b5e35d2dc3086faa54f82124cf38" title="Binds a resource to a fixed path.">addResource()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9631ac0b2b08d3e848120ad2f52cde85"></a><!-- doxytag: member="Wt::WServer::restart" ref="a9631ac0b2b08d3e848120ad2f52cde85" args="(int argc, char **argv, char **envp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WServer::restart </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>envp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A utility method to restart. </p>
<p>This will result the application with the new image (argv[0]), effectively loading a newly deployed version. <em>(Experimental, UNIX only)</em> </p>
</div>
</div>
<a class="anchor" id="ad27189183523a6d718db4c7733cd29ab"></a><!-- doxytag: member="Wt::WServer::resume" ref="ad27189183523a6d718db4c7733cd29ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WTCONNECTOR_API void Wt::WServer::resume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resumes the server. </p>
<p>This closes and reopens the listen socket(s) for accepting new TCP and/or SSL connections. This may be needed when the OS (like IPhoneOS) has closed the sockets while suspending the application. </p>
</div>
</div>
<a class="anchor" id="a91dfcff8af7c2c42f26d3e4033cd9657"></a><!-- doxytag: member="Wt::WServer::setIOService" ref="a91dfcff8af7c2c42f26d3e4033cd9657" args="(WIOService &ioService)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WServer::setIOService </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WIOService.html">WIOService</a> & </td>
<td class="paramname"><em>ioService</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the I/O service. </p>
<p>The server will use an I/O service for scheduling functions into a thread-pool, and to implement asynchronous networking, whose call-back funtions are scheduled in the same thread pool.</p>
<p>By default, a server will create its own I/O service, but you may configure it to reuse another I/O service. </p>
</div>
</div>
<a class="anchor" id="a58852f006b4a233b49c332e819e3dce2"></a><!-- doxytag: member="Wt::WServer::setServerConfiguration" ref="a58852f006b4a233b49c332e819e3dce2" args="(int argc, char *argv[], const std::string &serverConfigurationFile=std::string())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WTCONNECTOR_API void Wt::WServer::setServerConfiguration </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>serverConfigurationFile</em> = <code>std::string()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configures the HTTP(S) server or FastCGI process. </p>
<p>Configures the HTTP(S) server using command-line arguments, a configuration file, or both. The valid options are described in <a class="el" href="overview.html#config_wthttpd">Built-in httpd configuration</a>.</p>
<p>The applications themselves are configured using the configuration file passed to the constructor.</p>
<p>The server configuration must be set before any other functionality can be used.</p>
<p>In case of FastCGI deployment, the <code>serverConfigurationFile</code> argument is ignored, and depending on the command-line arguments, this process may become a FastCGI protocol relay process which never returning from this call but directs the FastCGI stream to the correct session, rather than a <a class="el" href="namespaceWt.html" title="The namespace for Wt.">Wt</a> application server.</p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classWt_1_1WServer_1_1Exception.html" title="Server Exception class.">Exception</a></td><td>: indicates a configuration problem. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a921af79ce0a6a35555409f2f844f8a72"></a><!-- doxytag: member="Wt::WServer::start" ref="a921af79ce0a6a35555409f2f844f8a72" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WTCONNECTOR_API bool Wt::WServer::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts the server in the background. </p>
<p>Returns whether the server could be successfully started.</p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classWt_1_1WServer_1_1Exception.html" title="Server Exception class.">Exception</a></td><td>: indicates a problem starting the server.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#af15ec00e54dc985606ffa07f5f8f4c4d" title="Returns whether the server is running.">isRunning()</a>, <a class="el" href="classWt_1_1WServer.html#a806538821ad3fe9b4b0b28c55fa160a0" title="Stops the server.">stop()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a806538821ad3fe9b4b0b28c55fa160a0"></a><!-- doxytag: member="Wt::WServer::stop" ref="a806538821ad3fe9b4b0b28c55fa160a0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WTCONNECTOR_API void Wt::WServer::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stops the server. </p>
<p>All active application sessions are terminated cleanly, and the HTTP(S) server is shut down.</p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classWt_1_1WServer_1_1Exception.html" title="Server Exception class.">Exception</a></td><td>: indicates a problem while stopping the server.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WServer.html#af15ec00e54dc985606ffa07f5f8f4c4d" title="Returns whether the server is running.">isRunning()</a>, <a class="el" href="classWt_1_1WServer.html#a921af79ce0a6a35555409f2f844f8a72" title="Starts the server in the background.">start()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a00d9eed95ef4519abfd139c76eda3ac9"></a><!-- doxytag: member="Wt::WServer::waitForShutdown" ref="a00d9eed95ef4519abfd139c76eda3ac9" args="(const char *restartWatchFile=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WServer::waitForShutdown </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>restartWatchFile</em> = <code>0</code></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for a shutdown signal. </p>
<p>This static method blocks the current thread, waiting for a shutdown signal. The implementation and details are platform dependent, but this is usually Ctrl-C (SIGINT) or SIGKILL.</p>
<p>This method is convenient if you want to customize how the server is started (by instantiating a <a class="el" href="classWt_1_1WServer.html" title="A class encapsulating a web application server.">WServer</a> object yourself, instead of using Wt::Wrun()), but still want to use Wt as a standalone server that cleanly terminates on interruption.</p>
<p>This will also catch SIGHUP, to reread the configuration file.</p>
<p>The optional <code>restartWatchFile</code> parameter is deprecated and no longer used. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abca6890dab44d87bd3af64705ac072d3"></a><!-- doxytag: member="Wt::WServer::WRun" ref="abca6890dab44d87bd3af64705ac072d3" args="(int argc, char **argv, ApplicationCreator createApplication=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int WRun </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ApplicationCreator </td>
<td class="paramname"><em>createApplication</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Runs the Wt application server. </p>
<p>This function runs the application server, and should be called only once (e.g. from within your main function).</p>
<p>The <code>createApplication</code> parameter is a <code>boost::function</code> object that should create a new application instance for a new user visiting the application. It is of type: <code>boost::function<<a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">Wt::WApplication</a>* (const <a class="el" href="classWt_1_1WEnvironment.html" title="A class that captures information on the application environment.">Wt::WEnvironment</a>&)></code>, and thus you can pass to it a function like:</p>
<pre>
<a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">Wt::WApplication</a> *createApplication(const <a class="el" href="classWt_1_1WEnvironment.html" title="A class that captures information on the application environment.">Wt::WEnvironment</a>& env)
{
// ...
}
</pre><p>When using the built-in httpd, the implementation listens for POSIX termination signals (or console CTRL-C) event. You can use the <a class="el" href="classWt_1_1WServer.html" title="A class encapsulating a web application server.">WServer</a> class for more flexible control on starting and stopping the server.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">WApplication</a> </dd></dl>
</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>
