<!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::WIOService 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_1WIOService.html">WIOService</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WIOService Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WIOService" -->
<p>An I/O service.
<a href="classWt_1_1WIOService.html#details">More...</a></p>
<p><code>#include <Wt/WIOService></code></p>
<p><a href="classWt_1_1WIOService-members.html">List of all members.</a></p>
<table class="memberdecls">
<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_1WIOService.html#a5ee1bf87cdc2eb1ff5fcc35dd8cddea4">WIOService</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new IO service. <a href="#a5ee1bf87cdc2eb1ff5fcc35dd8cddea4"></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_1WIOService.html#a4f79e83a51a786a9c22f431c11e7854d">setThreadCount</a> (int number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configures the number of threads. <a href="#a4f79e83a51a786a9c22f431c11e7854d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4024733940ece7a792f940655e5000d7"></a><!-- doxytag: member="Wt::WIOService::threadCount" ref="a4024733940ece7a792f940655e5000d7" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WIOService.html#a4024733940ece7a792f940655e5000d7">threadCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WIOService.html#a5816e47cc1c8a493f63dee8c5db8e7b3">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the I/O service. <a href="#a5816e47cc1c8a493f63dee8c5db8e7b3"></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_1WIOService.html#a9780f76f0e6f0159de0a57c78c2f1fad">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops the I/O service. <a href="#a9780f76f0e6f0159de0a57c78c2f1fad"></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_1WIOService.html#a657f0fc156b7dce861471051e0372c8b">post</a> (const boost::function< void()> &function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Posts a function into the thread-pool. <a href="#a657f0fc156b7dce861471051e0372c8b"></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_1WIOService.html#af21d302bdae0011e84f921b155d9a40d">schedule</a> (int milliSeconds, const boost::function< void()> &function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Schedules a function on the thread-pool. <a href="#af21d302bdae0011e84f921b155d9a40d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WIOService.html#a168ebe4ff00a8e9dbf8c303296d6ae2f">initializeThread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes a thread. <a href="#a168ebe4ff00a8e9dbf8c303296d6ae2f"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An I/O service. </p>
<p>! An I/O service combines a boost::asio::io_service with a thread pool. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5ee1bf87cdc2eb1ff5fcc35dd8cddea4"></a><!-- doxytag: member="Wt::WIOService::WIOService" ref="a5ee1bf87cdc2eb1ff5fcc35dd8cddea4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WIOService::WIOService </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new IO service. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>setServerConfiguration() </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a168ebe4ff00a8e9dbf8c303296d6ae2f"></a><!-- doxytag: member="Wt::WIOService::initializeThread" ref="a168ebe4ff00a8e9dbf8c303296d6ae2f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WIOService::initializeThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes a thread. </p>
<p>This function is called for every new thread created, and can be used to configure the thread, e.g. with respect to scheduling priorities. </p>
</div>
</div>
<a class="anchor" id="a657f0fc156b7dce861471051e0372c8b"></a><!-- doxytag: member="Wt::WIOService::post" ref="a657f0fc156b7dce861471051e0372c8b" args="(const boost::function< void()> &function)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WIOService::post </td>
<td>(</td>
<td class="paramtype">const boost::function< void()> & </td>
<td class="paramname"><em>function</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Posts a function into the thread-pool. </p>
<p>The function will be executed within a thread of the thread-pool.</p>
<p>This method returns immediately. </p>
</div>
</div>
<a class="anchor" id="af21d302bdae0011e84f921b155d9a40d"></a><!-- doxytag: member="Wt::WIOService::schedule" ref="af21d302bdae0011e84f921b155d9a40d" args="(int milliSeconds, const boost::function< void()> &function)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WIOService::schedule </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>milliSeconds</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Schedules a function on the thread-pool. </p>
<p>The function will be executed after a time out, specified in milli-seconds, on the thread pool. </p>
</div>
</div>
<a class="anchor" id="a4f79e83a51a786a9c22f431c11e7854d"></a><!-- doxytag: member="Wt::WIOService::setThreadCount" ref="a4f79e83a51a786a9c22f431c11e7854d" args="(int number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WIOService::setThreadCount </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>number</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configures the number of threads. </p>
<p>This must be configured before the server is started using <a class="el" href="classWt_1_1WIOService.html#a5816e47cc1c8a493f63dee8c5db8e7b3" title="Starts the I/O service.">start()</a>.</p>
<p>The default thread count is 10 (or is configured by <a class="el" href="classWt_1_1WServer.html" title="A class encapsulating a web application server.">WServer</a> from information in the configuration file). </p>
</div>
</div>
<a class="anchor" id="a5816e47cc1c8a493f63dee8c5db8e7b3"></a><!-- doxytag: member="Wt::WIOService::start" ref="a5816e47cc1c8a493f63dee8c5db8e7b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WIOService::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts the I/O service. </p>
<p>This will start the internal thread pool to process work for the I/O service, if not already started. </p>
</div>
</div>
<a class="anchor" id="a9780f76f0e6f0159de0a57c78c2f1fad"></a><!-- doxytag: member="Wt::WIOService::stop" ref="a9780f76f0e6f0159de0a57c78c2f1fad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WIOService::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stops the I/O service. </p>
<p>This will stop the internal thread pool. The method will block until all work has been completed. </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>
