diff options
Diffstat (limited to 'doc/html/boost_asio/reference/io_service')
27 files changed, 2161 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/io_service/_io_service.html b/doc/html/boost_asio/reference/io_service/_io_service.html new file mode 100755 index 0000000000..a22f7697b3 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/_io_service.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::~io_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="wrap.html" title="io_service::wrap"> +<link rel="next" href="../io_service__id.html" title="io_service::id"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wrap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../io_service__id.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service._io_service"></a><a class="link" href="_io_service.html" title="io_service::~io_service">io_service::~io_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1359289"></a> +Destructor. + </p> +<pre class="programlisting"><span class="special">~</span><span class="identifier">io_service</span><span class="special">();</span> +</pre> +<p> + On destruction, the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> performs the following + sequence of operations: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + For each service object <code class="computeroutput"><span class="identifier">svc</span></code> + in the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> set, in reverse + order of the beginning of service object lifetime, performs <code class="computeroutput"><span class="identifier">svc</span><span class="special">-></span><span class="identifier">shutdown_service</span><span class="special">()</span></code>. + </li> +<li class="listitem"> + Uninvoked handler objects that were scheduled for deferred invocation + on the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>, or any associated + strand, are destroyed. + </li> +<li class="listitem"> + For each service object <code class="computeroutput"><span class="identifier">svc</span></code> + in the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> set, in reverse + order of the beginning of service object lifetime, performs <code class="computeroutput"><span class="keyword">delete</span> <span class="keyword">static_cast</span><span class="special"><</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span><span class="special">*>(</span><span class="identifier">svc</span><span class="special">)</span></code>. + </li> +</ul></div> +<h6> +<a name="boost_asio.reference.io_service._io_service.h0"></a> + <span><a name="boost_asio.reference.io_service._io_service.remarks"></a></span><a class="link" href="_io_service.html#boost_asio.reference.io_service._io_service.remarks">Remarks</a> + </h6> +<p> + The destruction sequence described above permits programs to simplify their + resource management by using <code class="computeroutput"><span class="identifier">shared_ptr</span><span class="special"><></span></code>. Where an object's lifetime is + tied to the lifetime of a connection (or some other sequence of asynchronous + operations), a <code class="computeroutput"><span class="identifier">shared_ptr</span></code> + to the object would be bound into the handlers for all asynchronous operations + associated with it. This works as follows: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + When a single connection ends, all associated asynchronous operations + complete. The corresponding handler objects are destroyed, and all + <code class="computeroutput"><span class="identifier">shared_ptr</span></code> references + to the objects are destroyed. + </li> +<li class="listitem"> + To shut down the whole program, the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> function <code class="computeroutput"><span class="identifier">stop</span><span class="special">()</span></code> + is called to terminate any <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> calls as soon as possible. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + destructor defined above destroys all handlers, causing all <code class="computeroutput"><span class="identifier">shared_ptr</span></code> references to all connection + objects to be destroyed. + </li> +</ul></div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="wrap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../io_service__id.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/add_service.html b/doc/html/boost_asio/reference/io_service/add_service.html new file mode 100755 index 0000000000..78e2404ea3 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/add_service.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::add_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="../io_service.html" title="io_service"> +<link rel="next" href="dispatch.html" title="io_service::dispatch"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="dispatch.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.add_service"></a><a class="link" href="add_service.html" title="io_service::add_service">io_service::add_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1352108"></a> +Add a service object to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../Service.html" title="Service requirements">Service</a><span class="special">></span> +<span class="keyword">friend</span> <span class="keyword">void</span> <span class="identifier">add_service</span><span class="special">(</span> + <span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">ios</span><span class="special">,</span> + <span class="identifier">Service</span> <span class="special">*</span> <span class="identifier">svc</span><span class="special">);</span> +</pre> +<p> + This function is used to add a service to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. + </p> +<h6> +<a name="boost_asio.reference.io_service.add_service.h0"></a> + <span><a name="boost_asio.reference.io_service.add_service.parameters"></a></span><a class="link" href="add_service.html#boost_asio.reference.io_service.add_service.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ios</span></dt> +<dd><p> + The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that owns + the service. + </p></dd> +<dt><span class="term">svc</span></dt> +<dd> +<p> + The service object. On success, ownership of the service object is + transferred to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. When the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + object is destroyed, it will destroy the service object by performing: +</p> +<pre class="programlisting"><span class="keyword">delete</span> <span class="keyword">static_cast</span><span class="special"><</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span><span class="special">*>(</span><span class="identifier">svc</span><span class="special">)</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.add_service.h1"></a> + <span><a name="boost_asio.reference.io_service.add_service.exceptions"></a></span><a class="link" href="add_service.html#boost_asio.reference.io_service.add_service.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::asio::service_already_exists</span></dt> +<dd><p> + Thrown if a service of the given type is already present in the + <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. + </p></dd> +<dt><span class="term">boost::asio::invalid_service_owner</span></dt> +<dd><p> + Thrown if the service's owning <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> is not the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + object specified by the ios parameter. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.add_service.h2"></a> + <span><a name="boost_asio.reference.io_service.add_service.requirements"></a></span><a class="link" href="add_service.html#boost_asio.reference.io_service.add_service.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/io_service.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="dispatch.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/dispatch.html b/doc/html/boost_asio/reference/io_service/dispatch.html new file mode 100755 index 0000000000..935f64e6db --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/dispatch.html @@ -0,0 +1,107 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::dispatch</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="add_service.html" title="io_service::add_service"> +<link rel="next" href="fork_event.html" title="io_service::fork_event"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="add_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="fork_event.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.dispatch"></a><a class="link" href="dispatch.html" title="io_service::dispatch">io_service::dispatch</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1352582"></a> +Request the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> to invoke the given + handler. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../CompletionHandler.html" title="Completion handler requirements">CompletionHandler</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">dispatch</span><span class="special">(</span> + <span class="identifier">CompletionHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to ask the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> to execute the given + handler. + </p> +<p> + The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + guarantees that the handler will only be called in a thread in which the + <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + member functions is currently being invoked. The handler may be executed + inside this function if the guarantee can be met. + </p> +<h6> +<a name="boost_asio.reference.io_service.dispatch.h0"></a> + <span><a name="boost_asio.reference.io_service.dispatch.parameters"></a></span><a class="link" href="dispatch.html#boost_asio.reference.io_service.dispatch.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> will make a copy + of the handler object as required. The function signature of the + handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">();</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.dispatch.h1"></a> + <span><a name="boost_asio.reference.io_service.dispatch.remarks"></a></span><a class="link" href="dispatch.html#boost_asio.reference.io_service.dispatch.remarks">Remarks</a> + </h6> +<p> + This function throws an exception only if: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + the handler's <code class="computeroutput"><span class="identifier">asio_handler_allocate</span></code> + function; or + </li> +<li class="listitem"> + the handler's copy constructor + </li> +</ul></div> +<p> + throws an exception. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="add_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="fork_event.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/fork_event.html b/doc/html/boost_asio/reference/io_service/fork_event.html new file mode 100755 index 0000000000..ddf2bb7c5d --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/fork_event.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::fork_event</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="dispatch.html" title="io_service::dispatch"> +<link rel="next" href="has_service.html" title="io_service::has_service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="has_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.fork_event"></a><a class="link" href="fork_event.html" title="io_service::fork_event">io_service::fork_event</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1352940"></a> +Fork-related event notifications. + </p> +<pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">fork_event</span> +</pre> +<p> + <a class="indexterm" name="id1352969"></a> + <a class="indexterm" name="id1352978"></a> + <a class="indexterm" name="id1352987"></a> + </p> +<h6> +<a name="boost_asio.reference.io_service.fork_event.h0"></a> + <span><a name="boost_asio.reference.io_service.fork_event.values"></a></span><a class="link" href="fork_event.html#boost_asio.reference.io_service.fork_event.values">Values</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">fork_prepare</span></dt> +<dd><p> + Notify the io_service that the process is about to fork. + </p></dd> +<dt><span class="term">fork_parent</span></dt> +<dd><p> + Notify the io_service that the process has forked and is the parent. + </p></dd> +<dt><span class="term">fork_child</span></dt> +<dd><p> + Notify the io_service that the process has forked and is the child. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="has_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/has_service.html b/doc/html/boost_asio/reference/io_service/has_service.html new file mode 100755 index 0000000000..3c895fa868 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/has_service.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::has_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="fork_event.html" title="io_service::fork_event"> +<link rel="next" href="io_service.html" title="io_service::io_service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="fork_event.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.has_service"></a><a class="link" href="has_service.html" title="io_service::has_service">io_service::has_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1353092"></a> +Determine if an <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> contains a specified + service type. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../Service.html" title="Service requirements">Service</a><span class="special">></span> +<span class="keyword">friend</span> <span class="keyword">bool</span> <span class="identifier">has_service</span><span class="special">(</span> + <span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">ios</span><span class="special">);</span> +</pre> +<p> + This function is used to determine whether the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> contains a service + object corresponding to the given service type. + </p> +<h6> +<a name="boost_asio.reference.io_service.has_service.h0"></a> + <span><a name="boost_asio.reference.io_service.has_service.parameters"></a></span><a class="link" href="has_service.html#boost_asio.reference.io_service.has_service.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ios</span></dt> +<dd><p> + The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that owns + the service. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.has_service.h1"></a> + <span><a name="boost_asio.reference.io_service.has_service.return_value"></a></span><a class="link" href="has_service.html#boost_asio.reference.io_service.has_service.return_value">Return + Value</a> + </h6> +<p> + A boolean indicating whether the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> contains the service. + </p> +<h6> +<a name="boost_asio.reference.io_service.has_service.h2"></a> + <span><a name="boost_asio.reference.io_service.has_service.requirements"></a></span><a class="link" href="has_service.html#boost_asio.reference.io_service.has_service.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/io_service.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="fork_event.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/io_service.html b/doc/html/boost_asio/reference/io_service/io_service.html new file mode 100755 index 0000000000..6acf80b905 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/io_service.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::io_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="has_service.html" title="io_service::has_service"> +<link rel="next" href="io_service/overload1.html" title="io_service::io_service (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="has_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="io_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.io_service"></a><a class="link" href="io_service.html" title="io_service::io_service">io_service::io_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1353390"></a> +Constructor. + </p> +<pre class="programlisting"><a class="link" href="io_service/overload1.html" title="io_service::io_service (1 of 2 overloads)">io_service</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="io_service/overload1.html" title="io_service::io_service (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">explicit</span> <a class="link" href="io_service/overload2.html" title="io_service::io_service (2 of 2 overloads)">io_service</a><span class="special">(</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">concurrency_hint</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="io_service/overload2.html" title="io_service::io_service (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="has_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="io_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/io_service/overload1.html b/doc/html/boost_asio/reference/io_service/io_service/overload1.html new file mode 100755 index 0000000000..c9883bf997 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/io_service/overload1.html @@ -0,0 +1,49 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::io_service (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service::io_service"> +<link rel="prev" href="../io_service.html" title="io_service::io_service"> +<link rel="next" href="overload2.html" title="io_service::io_service (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../io_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.io_service.overload1"></a><a class="link" href="overload1.html" title="io_service::io_service (1 of 2 overloads)">io_service::io_service + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Constructor. + </p> +<pre class="programlisting"><span class="identifier">io_service</span><span class="special">();</span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../io_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/io_service/overload2.html b/doc/html/boost_asio/reference/io_service/io_service/overload2.html new file mode 100755 index 0000000000..e86c7d46e1 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/io_service/overload2.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::io_service (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service::io_service"> +<link rel="prev" href="overload1.html" title="io_service::io_service (1 of 2 overloads)"> +<link rel="next" href="../notify_fork.html" title="io_service::notify_fork"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../notify_fork.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.io_service.overload2"></a><a class="link" href="overload2.html" title="io_service::io_service (2 of 2 overloads)">io_service::io_service + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Constructor. + </p> +<pre class="programlisting"><span class="identifier">io_service</span><span class="special">(</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">concurrency_hint</span><span class="special">);</span> +</pre> +<p> + Construct with a hint about the required level of concurrency. + </p> +<h6> +<a name="boost_asio.reference.io_service.io_service.overload2.h0"></a> + <span><a name="boost_asio.reference.io_service.io_service.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.io_service.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">concurrency_hint</span></dt> +<dd><p> + A suggestion to the implementation on how many threads it should + allow to run simultaneously. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../notify_fork.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/notify_fork.html b/doc/html/boost_asio/reference/io_service/notify_fork.html new file mode 100755 index 0000000000..8fa9ca2427 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/notify_fork.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::notify_fork</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="io_service/overload2.html" title="io_service::io_service (2 of 2 overloads)"> +<link rel="next" href="poll.html" title="io_service::poll"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="io_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="poll.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.notify_fork"></a><a class="link" href="notify_fork.html" title="io_service::notify_fork">io_service::notify_fork</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1353655"></a> +Notify the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> of a fork-related event. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">notify_fork</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">fork_event</span> <span class="identifier">event</span><span class="special">);</span> +</pre> +<p> + This function is used to inform the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> that the process is + about to fork, or has just forked. This allows the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>, and the services it + contains, to perform any necessary housekeeping to ensure correct operation + following a fork. + </p> +<p> + This function must not be called while any other <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> function, or any function + on an I/O object associated with the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>, is being called in + another thread. It is, however, safe to call this function from within + a completion handler, provided no other thread is accessing the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. + </p> +<h6> +<a name="boost_asio.reference.io_service.notify_fork.h0"></a> + <span><a name="boost_asio.reference.io_service.notify_fork.parameters"></a></span><a class="link" href="notify_fork.html#boost_asio.reference.io_service.notify_fork.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">event</span></dt> +<dd><p> + A fork-related event. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.notify_fork.h1"></a> + <span><a name="boost_asio.reference.io_service.notify_fork.exceptions"></a></span><a class="link" href="notify_fork.html#boost_asio.reference.io_service.notify_fork.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. If the notification fails the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object should + no longer be used and should be destroyed. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.notify_fork.h2"></a> + <span><a name="boost_asio.reference.io_service.notify_fork.example"></a></span><a class="link" href="notify_fork.html#boost_asio.reference.io_service.notify_fork.example">Example</a> + </h6> +<p> + The following code illustrates how to incorporate the <code class="computeroutput"><span class="identifier">notify_fork</span><span class="special">()</span></code> function: + </p> +<pre class="programlisting"><span class="identifier">my_io_service</span><span class="special">.</span><span class="identifier">notify_fork</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">fork_prepare</span><span class="special">);</span> +<span class="keyword">if</span> <span class="special">(</span><span class="identifier">fork</span><span class="special">()</span> <span class="special">==</span> <span class="number">0</span><span class="special">)</span> +<span class="special">{</span> + <span class="comment">// This is the child process.</span> + <span class="identifier">my_io_service</span><span class="special">.</span><span class="identifier">notify_fork</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">fork_child</span><span class="special">);</span> +<span class="special">}</span> +<span class="keyword">else</span> +<span class="special">{</span> + <span class="comment">// This is the parent process.</span> + <span class="identifier">my_io_service</span><span class="special">.</span><span class="identifier">notify_fork</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">fork_parent</span><span class="special">);</span> +<span class="special">}</span> +</pre> +<h6> +<a name="boost_asio.reference.io_service.notify_fork.h3"></a> + <span><a name="boost_asio.reference.io_service.notify_fork.remarks"></a></span><a class="link" href="notify_fork.html#boost_asio.reference.io_service.notify_fork.remarks">Remarks</a> + </h6> +<p> + For each service object <code class="computeroutput"><span class="identifier">svc</span></code> + in the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + set, performs <code class="computeroutput"><span class="identifier">svc</span><span class="special">-></span><span class="identifier">fork_service</span><span class="special">();</span></code>. + When processing the fork_prepare event, services are visited in reverse + order of the beginning of service object lifetime. Otherwise, services + are visited in order of the beginning of service object lifetime. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="io_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="poll.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/poll.html b/doc/html/boost_asio/reference/io_service/poll.html new file mode 100755 index 0000000000..91983035b1 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/poll.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::poll</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="notify_fork.html" title="io_service::notify_fork"> +<link rel="next" href="poll/overload1.html" title="io_service::poll (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="notify_fork.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="poll/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.poll"></a><a class="link" href="poll.html" title="io_service::poll">io_service::poll</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1354330"></a> +Run the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute ready handlers. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="poll/overload1.html" title="io_service::poll (1 of 2 overloads)">poll</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="poll/overload1.html" title="io_service::poll (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="poll/overload2.html" title="io_service::poll (2 of 2 overloads)">poll</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="poll/overload2.html" title="io_service::poll (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="notify_fork.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="poll/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/poll/overload1.html b/doc/html/boost_asio/reference/io_service/poll/overload1.html new file mode 100755 index 0000000000..16528ae57d --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/poll/overload1.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::poll (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../poll.html" title="io_service::poll"> +<link rel="prev" href="../poll.html" title="io_service::poll"> +<link rel="next" href="overload2.html" title="io_service::poll (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../poll.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.poll.overload1"></a><a class="link" href="overload1.html" title="io_service::poll (1 of 2 overloads)">io_service::poll + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute ready handlers. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">poll</span><span class="special">();</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + function runs handlers that are ready to run, without blocking, until + the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + has been stopped or there are no more ready handlers. + </p> +<h6> +<a name="boost_asio.reference.io_service.poll.overload1.h0"></a> + <span><a name="boost_asio.reference.io_service.poll.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.poll.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. + </p> +<h6> +<a name="boost_asio.reference.io_service.poll.overload1.h1"></a> + <span><a name="boost_asio.reference.io_service.poll.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.poll.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../poll.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/poll/overload2.html b/doc/html/boost_asio/reference/io_service/poll/overload2.html new file mode 100755 index 0000000000..82eda3af44 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/poll/overload2.html @@ -0,0 +1,78 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::poll (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../poll.html" title="io_service::poll"> +<link rel="prev" href="overload1.html" title="io_service::poll (1 of 2 overloads)"> +<link rel="next" href="../poll_one.html" title="io_service::poll_one"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../poll_one.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.poll.overload2"></a><a class="link" href="overload2.html" title="io_service::poll (2 of 2 overloads)">io_service::poll + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute ready handlers. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">poll</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + function runs handlers that are ready to run, without blocking, until + the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + has been stopped or there are no more ready handlers. + </p> +<h6> +<a name="boost_asio.reference.io_service.poll.overload2.h0"></a> + <span><a name="boost_asio.reference.io_service.poll.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.poll.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.poll.overload2.h1"></a> + <span><a name="boost_asio.reference.io_service.poll.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.poll.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../poll_one.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/poll_one.html b/doc/html/boost_asio/reference/io_service/poll_one.html new file mode 100755 index 0000000000..0830671b3d --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/poll_one.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::poll_one</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="poll/overload2.html" title="io_service::poll (2 of 2 overloads)"> +<link rel="next" href="poll_one/overload1.html" title="io_service::poll_one (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="poll/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="poll_one/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.poll_one"></a><a class="link" href="poll_one.html" title="io_service::poll_one">io_service::poll_one</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1354892"></a> +Run the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute one ready handler. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="poll_one/overload1.html" title="io_service::poll_one (1 of 2 overloads)">poll_one</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="poll_one/overload1.html" title="io_service::poll_one (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="poll_one/overload2.html" title="io_service::poll_one (2 of 2 overloads)">poll_one</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="poll_one/overload2.html" title="io_service::poll_one (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="poll/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="poll_one/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/poll_one/overload1.html b/doc/html/boost_asio/reference/io_service/poll_one/overload1.html new file mode 100755 index 0000000000..d492f4214c --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/poll_one/overload1.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::poll_one (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../poll_one.html" title="io_service::poll_one"> +<link rel="prev" href="../poll_one.html" title="io_service::poll_one"> +<link rel="next" href="overload2.html" title="io_service::poll_one (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../poll_one.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.poll_one.overload1"></a><a class="link" href="overload1.html" title="io_service::poll_one (1 of 2 overloads)">io_service::poll_one + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute one ready handler. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">poll_one</span><span class="special">();</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + function runs at most one handler that is ready to run, without blocking. + </p> +<h6> +<a name="boost_asio.reference.io_service.poll_one.overload1.h0"></a> + <span><a name="boost_asio.reference.io_service.poll_one.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.poll_one.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. + </p> +<h6> +<a name="boost_asio.reference.io_service.poll_one.overload1.h1"></a> + <span><a name="boost_asio.reference.io_service.poll_one.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.poll_one.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../poll_one.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/poll_one/overload2.html b/doc/html/boost_asio/reference/io_service/poll_one/overload2.html new file mode 100755 index 0000000000..08587fc215 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/poll_one/overload2.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::poll_one (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../poll_one.html" title="io_service::poll_one"> +<link rel="prev" href="overload1.html" title="io_service::poll_one (1 of 2 overloads)"> +<link rel="next" href="../post.html" title="io_service::post"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../post.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.poll_one.overload2"></a><a class="link" href="overload2.html" title="io_service::poll_one (2 of 2 overloads)">io_service::poll_one + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute one ready handler. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">poll_one</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + function runs at most one handler that is ready to run, without blocking. + </p> +<h6> +<a name="boost_asio.reference.io_service.poll_one.overload2.h0"></a> + <span><a name="boost_asio.reference.io_service.poll_one.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.poll_one.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.poll_one.overload2.h1"></a> + <span><a name="boost_asio.reference.io_service.poll_one.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.poll_one.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../poll_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../post.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/post.html b/doc/html/boost_asio/reference/io_service/post.html new file mode 100755 index 0000000000..5ace3de21a --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/post.html @@ -0,0 +1,107 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::post</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="poll_one/overload2.html" title="io_service::poll_one (2 of 2 overloads)"> +<link rel="next" href="reset.html" title="io_service::reset"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="poll_one/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reset.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.post"></a><a class="link" href="post.html" title="io_service::post">io_service::post</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1355424"></a> +Request the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> to invoke the given + handler and return immediately. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../CompletionHandler.html" title="Completion handler requirements">CompletionHandler</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">post</span><span class="special">(</span> + <span class="identifier">CompletionHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to ask the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> to execute the given + handler, but without allowing the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> to call the handler + from inside this function. + </p> +<p> + The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + guarantees that the handler will only be called in a thread in which the + <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + member functions is currently being invoked. + </p> +<h6> +<a name="boost_asio.reference.io_service.post.h0"></a> + <span><a name="boost_asio.reference.io_service.post.parameters"></a></span><a class="link" href="post.html#boost_asio.reference.io_service.post.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> will make a copy + of the handler object as required. The function signature of the + handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">();</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.post.h1"></a> + <span><a name="boost_asio.reference.io_service.post.remarks"></a></span><a class="link" href="post.html#boost_asio.reference.io_service.post.remarks">Remarks</a> + </h6> +<p> + This function throws an exception only if: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + the handler's <code class="computeroutput"><span class="identifier">asio_handler_allocate</span></code> + function; or + </li> +<li class="listitem"> + the handler's copy constructor + </li> +</ul></div> +<p> + throws an exception. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="poll_one/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reset.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/reset.html b/doc/html/boost_asio/reference/io_service/reset.html new file mode 100755 index 0000000000..5adeb565bd --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/reset.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::reset</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="post.html" title="io_service::post"> +<link rel="next" href="run.html" title="io_service::run"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="post.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.reset"></a><a class="link" href="reset.html" title="io_service::reset">io_service::reset</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1355794"></a> +Reset the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> in preparation for + a subsequent <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> + invocation. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">reset</span><span class="special">();</span> +</pre> +<p> + This function must be called prior to any second or later set of invocations + of the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + functions when a previous invocation of these functions returned due to + the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + being stopped or running out of work. After a call to <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code>, the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's <code class="computeroutput"><span class="identifier">stopped</span><span class="special">()</span></code> + function will return <code class="computeroutput"><span class="keyword">false</span></code>. + </p> +<p> + This function must not be called while there are any unfinished calls to + the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + functions. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="post.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/run.html b/doc/html/boost_asio/reference/io_service/run.html new file mode 100755 index 0000000000..c79fbb8869 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/run.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::run</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="reset.html" title="io_service::reset"> +<link rel="next" href="run/overload1.html" title="io_service::run (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reset.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.run"></a><a class="link" href="run.html" title="io_service::run">io_service::run</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1356075"></a> +Run the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="run/overload1.html" title="io_service::run (1 of 2 overloads)">run</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="run/overload1.html" title="io_service::run (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="run/overload2.html" title="io_service::run (2 of 2 overloads)">run</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="run/overload2.html" title="io_service::run (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="reset.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/run/overload1.html b/doc/html/boost_asio/reference/io_service/run/overload1.html new file mode 100755 index 0000000000..eca06aa0bf --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/run/overload1.html @@ -0,0 +1,106 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::run (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../run.html" title="io_service::run"> +<link rel="prev" href="../run.html" title="io_service::run"> +<link rel="next" href="overload2.html" title="io_service::run (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../run.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.run.overload1"></a><a class="link" href="overload1.html" title="io_service::run (1 of 2 overloads)">io_service::run + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">run</span><span class="special">();</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> + function blocks until all work has finished and there are no more handlers + to be dispatched, or until the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> has been stopped. + </p> +<p> + Multiple threads may call the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> function to set up a pool of threads + from which the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> may execute handlers. + All threads that are waiting in the pool are equivalent and the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + may choose any one of them to invoke a handler. + </p> +<p> + A normal exit from the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> function implies that the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object is stopped + (the <code class="computeroutput"><span class="identifier">stopped</span><span class="special">()</span></code> + function returns <code class="computeroutput"><span class="keyword">true</span></code>). + Subsequent calls to <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> will return immediately unless there + is a prior call to <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code>. + </p> +<h6> +<a name="boost_asio.reference.io_service.run.overload1.h0"></a> + <span><a name="boost_asio.reference.io_service.run.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.run.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. + </p> +<h6> +<a name="boost_asio.reference.io_service.run.overload1.h1"></a> + <span><a name="boost_asio.reference.io_service.run.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.run.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.run.overload1.h2"></a> + <span><a name="boost_asio.reference.io_service.run.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.run.overload1.remarks">Remarks</a> + </h6> +<p> + The <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> + function must not be called from a thread that is currently calling one + of <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + on the same <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object. + </p> +<p> + The <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + function may also be used to dispatch ready handlers, but without blocking. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../run.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/run/overload2.html b/doc/html/boost_asio/reference/io_service/run/overload2.html new file mode 100755 index 0000000000..9b02a2ba17 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/run/overload2.html @@ -0,0 +1,107 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::run (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../run.html" title="io_service::run"> +<link rel="prev" href="overload1.html" title="io_service::run (1 of 2 overloads)"> +<link rel="next" href="../run_one.html" title="io_service::run_one"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../run_one.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.run.overload2"></a><a class="link" href="overload2.html" title="io_service::run (2 of 2 overloads)">io_service::run + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">run</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> + function blocks until all work has finished and there are no more handlers + to be dispatched, or until the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> has been stopped. + </p> +<p> + Multiple threads may call the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> function to set up a pool of threads + from which the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> may execute handlers. + All threads that are waiting in the pool are equivalent and the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + may choose any one of them to invoke a handler. + </p> +<p> + A normal exit from the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> function implies that the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object is stopped + (the <code class="computeroutput"><span class="identifier">stopped</span><span class="special">()</span></code> + function returns <code class="computeroutput"><span class="keyword">true</span></code>). + Subsequent calls to <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> will return immediately unless there + is a prior call to <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code>. + </p> +<h6> +<a name="boost_asio.reference.io_service.run.overload2.h0"></a> + <span><a name="boost_asio.reference.io_service.run.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.run.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.run.overload2.h1"></a> + <span><a name="boost_asio.reference.io_service.run.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.run.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. + </p> +<h6> +<a name="boost_asio.reference.io_service.run.overload2.h2"></a> + <span><a name="boost_asio.reference.io_service.run.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.run.overload2.remarks">Remarks</a> + </h6> +<p> + The <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> + function must not be called from a thread that is currently calling one + of <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + on the same <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object. + </p> +<p> + The <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + function may also be used to dispatch ready handlers, but without blocking. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../run_one.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/run_one.html b/doc/html/boost_asio/reference/io_service/run_one.html new file mode 100755 index 0000000000..74790e4e01 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/run_one.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::run_one</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="run/overload2.html" title="io_service::run (2 of 2 overloads)"> +<link rel="next" href="run_one/overload1.html" title="io_service::run_one (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run_one/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.run_one"></a><a class="link" href="run_one.html" title="io_service::run_one">io_service::run_one</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1357287"></a> +Run the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute at most one handler. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="run_one/overload1.html" title="io_service::run_one (1 of 2 overloads)">run_one</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="run_one/overload1.html" title="io_service::run_one (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="run_one/overload2.html" title="io_service::run_one (2 of 2 overloads)">run_one</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="run_one/overload2.html" title="io_service::run_one (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run_one/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/run_one/overload1.html b/doc/html/boost_asio/reference/io_service/run_one/overload1.html new file mode 100755 index 0000000000..a3b6d525b3 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/run_one/overload1.html @@ -0,0 +1,82 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::run_one (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../run_one.html" title="io_service::run_one"> +<link rel="prev" href="../run_one.html" title="io_service::run_one"> +<link rel="next" href="overload2.html" title="io_service::run_one (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../run_one.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.run_one.overload1"></a><a class="link" href="overload1.html" title="io_service::run_one (1 of 2 overloads)">io_service::run_one + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute at most one handler. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">run_one</span><span class="special">();</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code> + function blocks until one handler has been dispatched, or until the + <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + has been stopped. + </p> +<h6> +<a name="boost_asio.reference.io_service.run_one.overload1.h0"></a> + <span><a name="boost_asio.reference.io_service.run_one.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.run_one.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. A zero return value implies + that the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object is stopped + (the <code class="computeroutput"><span class="identifier">stopped</span><span class="special">()</span></code> + function returns <code class="computeroutput"><span class="keyword">true</span></code>). + Subsequent calls to <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> will return immediately unless there + is a prior call to <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code>. + </p> +<h6> +<a name="boost_asio.reference.io_service.run_one.overload1.h1"></a> + <span><a name="boost_asio.reference.io_service.run_one.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.io_service.run_one.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../run_one.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/run_one/overload2.html b/doc/html/boost_asio/reference/io_service/run_one/overload2.html new file mode 100755 index 0000000000..d7df2931fc --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/run_one/overload2.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::run_one (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../run_one.html" title="io_service::run_one"> +<link rel="prev" href="overload1.html" title="io_service::run_one (1 of 2 overloads)"> +<link rel="next" href="../stop.html" title="io_service::stop"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../stop.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.io_service.run_one.overload2"></a><a class="link" href="overload2.html" title="io_service::run_one (2 of 2 overloads)">io_service::run_one + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Run the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop to execute at most one handler. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">run_one</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + The <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code> + function blocks until one handler has been dispatched, or until the + <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + has been stopped. + </p> +<h6> +<a name="boost_asio.reference.io_service.run_one.overload2.h0"></a> + <span><a name="boost_asio.reference.io_service.run_one.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_service.run_one.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of handlers that were executed. A zero return value implies + that the <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object is stopped + (the <code class="computeroutput"><span class="identifier">stopped</span><span class="special">()</span></code> + function returns <code class="computeroutput"><span class="keyword">true</span></code>). + Subsequent calls to <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> will return immediately unless there + is a prior call to <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code>. + </p> +<p> + The number of handlers that were executed. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../run_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../stop.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/stop.html b/doc/html/boost_asio/reference/io_service/stop.html new file mode 100755 index 0000000000..13243e5aaa --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/stop.html @@ -0,0 +1,61 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::stop</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="run_one/overload2.html" title="io_service::run_one (2 of 2 overloads)"> +<link rel="next" href="stopped.html" title="io_service::stopped"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run_one/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stopped.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.stop"></a><a class="link" href="stop.html" title="io_service::stop">io_service::stop</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1358042"></a> +Stop the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's event processing + loop. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">stop</span><span class="special">();</span> +</pre> +<p> + This function does not block, but instead simply signals the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> to stop. All invocations + of its <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code> + member functions should return as soon as possible. Subsequent calls to + <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> + will return immediately until <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code> is called. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run_one/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="stopped.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/stopped.html b/doc/html/boost_asio/reference/io_service/stopped.html new file mode 100755 index 0000000000..8267a37aac --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/stopped.html @@ -0,0 +1,64 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::stopped</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="stop.html" title="io_service::stop"> +<link rel="next" href="use_service.html" title="io_service::use_service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stop.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="use_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.stopped"></a><a class="link" href="stopped.html" title="io_service::stopped">io_service::stopped</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1358232"></a> +Determine whether the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object has been stopped. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">stopped</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to determine whether an <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object has been stopped, + either through an explicit call to <code class="computeroutput"><span class="identifier">stop</span><span class="special">()</span></code>, or due to running out of work. When + an <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + object is stopped, calls to <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>, <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code> will return immediately without invoking + any handlers. + </p> +<h6> +<a name="boost_asio.reference.io_service.stopped.h0"></a> + <span><a name="boost_asio.reference.io_service.stopped.return_value"></a></span><a class="link" href="stopped.html#boost_asio.reference.io_service.stopped.return_value">Return Value</a> + </h6> +<p> + <code class="computeroutput"><span class="keyword">true</span></code> if the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object is stopped, + otherwise <code class="computeroutput"><span class="keyword">false</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stop.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="use_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/use_service.html b/doc/html/boost_asio/reference/io_service/use_service.html new file mode 100755 index 0000000000..9af6125deb --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/use_service.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::use_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="stopped.html" title="io_service::stopped"> +<link rel="next" href="wrap.html" title="io_service::wrap"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stopped.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wrap.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.use_service"></a><a class="link" href="use_service.html" title="io_service::use_service">io_service::use_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1358483"></a> +Obtain the service object corresponding to the given + type. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../Service.html" title="Service requirements">Service</a><span class="special">></span> +<span class="keyword">friend</span> <span class="identifier">Service</span> <span class="special">&</span> <span class="identifier">use_service</span><span class="special">(</span> + <span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">ios</span><span class="special">);</span> +</pre> +<p> + This function is used to locate a service object that corresponds to the + given service type. If there is no existing implementation of the service, + then the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> will create a new instance + of the service. + </p> +<h6> +<a name="boost_asio.reference.io_service.use_service.h0"></a> + <span><a name="boost_asio.reference.io_service.use_service.parameters"></a></span><a class="link" href="use_service.html#boost_asio.reference.io_service.use_service.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ios</span></dt> +<dd><p> + The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that owns + the service. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.use_service.h1"></a> + <span><a name="boost_asio.reference.io_service.use_service.return_value"></a></span><a class="link" href="use_service.html#boost_asio.reference.io_service.use_service.return_value">Return + Value</a> + </h6> +<p> + The service interface implementing the specified service type. Ownership + of the service interface is not transferred to the caller. + </p> +<h6> +<a name="boost_asio.reference.io_service.use_service.h2"></a> + <span><a name="boost_asio.reference.io_service.use_service.requirements"></a></span><a class="link" href="use_service.html#boost_asio.reference.io_service.use_service.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/io_service.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="stopped.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wrap.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service/wrap.html b/doc/html/boost_asio/reference/io_service/wrap.html new file mode 100755 index 0000000000..05bed241cd --- /dev/null +++ b/doc/html/boost_asio/reference/io_service/wrap.html @@ -0,0 +1,105 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::wrap</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_service.html" title="io_service"> +<link rel="prev" href="use_service.html" title="io_service::use_service"> +<link rel="next" href="_io_service.html" title="io_service::~io_service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="use_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.io_service.wrap"></a><a class="link" href="wrap.html" title="io_service::wrap">io_service::wrap</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1358760"></a> +Create a new handler that automatically dispatches the wrapped + handler on the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span class="special">></span> +<span class="identifier">unspecified</span> <span class="identifier">wrap</span><span class="special">(</span> + <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to create a new handler function object that, when + invoked, will automatically pass the wrapped handler to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's dispatch function. + </p> +<h6> +<a name="boost_asio.reference.io_service.wrap.h0"></a> + <span><a name="boost_asio.reference.io_service.wrap.parameters"></a></span><a class="link" href="wrap.html#boost_asio.reference.io_service.wrap.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be wrapped. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> will make a copy + of the handler object as required. The function signature of the + handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service.wrap.h1"></a> + <span><a name="boost_asio.reference.io_service.wrap.return_value"></a></span><a class="link" href="wrap.html#boost_asio.reference.io_service.wrap.return_value">Return + Value</a> + </h6> +<p> + A function object that, when invoked, passes the wrapped handler to the + <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> + object's dispatch function. Given a function object with the signature: + </p> +<pre class="programlisting"><span class="identifier">R</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span> +</pre> +<p> + If this function object is passed to the wrap function like so: + </p> +<pre class="programlisting"><span class="identifier">io_service</span><span class="special">.</span><span class="identifier">wrap</span><span class="special">(</span><span class="identifier">f</span><span class="special">);</span> +</pre> +<p> + then the return value is a function object with the signature + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">g</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span> +</pre> +<p> + that, when invoked, executes code equivalent to: + </p> +<pre class="programlisting"><span class="identifier">io_service</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">an</span><span class="special">));</span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="use_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |