doc/html/boost_asio/reference/io_service/run_one/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>io_service::run_one (1 of 2 overloads)</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="../run_one.html" title="io_service::run_one">
   9 <link rel="prev" href="../run_one.html" title="io_service::run_one">
  10 <link rel="next" href="overload2.html" title="io_service::run_one (2 of 2 overloads)">
  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="../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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <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
  28           (1 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             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
  32             loop to execute at most one handler.
  33           </p>
  34 <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>
  35 </pre>
  36 <p>
  37             The <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>
  38             function blocks until one handler has been dispatched, or until the
  39             <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  40             has been stopped.
  41           </p>
  42 <h6>
  43 <a name="boost_asio.reference.io_service.run_one.overload1.h0"></a>
  44             <span class="phrase"><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
  45             Value</a>
  46           </h6>
  47 <p>
  48             The number of handlers that were executed. A zero return value implies
  49             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
  50             (the <code class="computeroutput"><span class="identifier">stopped</span><span class="special">()</span></code>
  51             function returns <code class="computeroutput"><span class="keyword">true</span></code>).
  52             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
  53             is a prior call to <code class="computeroutput"><span class="identifier">reset</span><span class="special">()</span></code>.
  54           </p>
  55 <h6>
  56 <a name="boost_asio.reference.io_service.run_one.overload1.h1"></a>
  57             <span class="phrase"><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>
  58           </h6>
  59 <div class="variablelist">
  60 <p class="title"><b></b></p>
  61 <dl class="variablelist">
  62 <dt><span class="term">boost::system::system_error</span></dt>
  63 <dd><p>
  64                   Thrown on failure.
  65                 </p></dd>
  66 </dl>
  67 </div>
  68 </div>
  69 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  70 <td align="left"></td>
  71 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  72         Distributed under the Boost Software License, Version 1.0. (See accompanying
  73         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>)
  74       </p>
  75 </div></td>
  76 </tr></table>
  77 <hr>
  78 <div class="spirit-nav">
  79 <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>
  80 </div>
  81 </body>
  82 </html>