doc/html/boost_asio/reference/io_service/reset.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>io_service::reset</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../io_service.html" title="io_service">
   9 <link rel="prev" href="post.html" title="io_service::post">
  10 <link rel="next" href="run.html" title="io_service::run">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.io_service.reset"></a><a class="link" href="reset.html" title="io_service::reset">io_service::reset</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp145284720"></a>
  31 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
  32           a subsequent <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>
  33           invocation.
  34         </p>
  35 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">reset</span><span class="special">();</span>
  36 </pre>
  37 <p>
  38           This function must be called prior to any second or later set of invocations
  39           of the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>,
  40           <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>,
  41           <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code>
  42           or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code>
  43           functions when a previous invocation of these functions returned due to
  44           the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  45           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>
  46           function will return <code class="computeroutput"><span class="keyword">false</span></code>.
  47         </p>
  48 <p>
  49           This function must not be called while there are any unfinished calls to
  50           the <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>,
  51           <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>,
  52           <code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code>
  53           or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code>
  54           functions.
  55         </p>
  56 </div>
  57 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  58 <td align="left"></td>
  59 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  60         Distributed under the Boost Software License, Version 1.0. (See accompanying
  61         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>)
  62       </p>
  63 </div></td>
  64 </tr></table>
  65 <hr>
  66 <div class="spirit-nav">
  67 <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>
  68 </div>
  69 </body>
  70 </html>