doc/html/boost_asio/reference/io_service/stopped.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>io_service::stopped</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="stop.html" title="io_service::stop">
  10 <link rel="next" href="use_service.html" title="io_service::use_service">
  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="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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.io_service.stopped"></a><a class="link" href="stopped.html" title="io_service::stopped">io_service::stopped</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp145520832"></a>
  31 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.
  32         </p>
  33 <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>
  34 </pre>
  35 <p>
  36           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,
  37           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
  38           an <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  39           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
  40           any handlers.
  41         </p>
  42 <h6>
  43 <a name="boost_asio.reference.io_service.stopped.h0"></a>
  44           <span class="phrase"><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>
  45         </h6>
  46 <p>
  47           <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,
  48           otherwise <code class="computeroutput"><span class="keyword">false</span></code>.
  49         </p>
  50 </div>
  51 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  52 <td align="left"></td>
  53 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  54         Distributed under the Boost Software License, Version 1.0. (See accompanying
  55         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>)
  56       </p>
  57 </div></td>
  58 </tr></table>
  59 <hr>
  60 <div class="spirit-nav">
  61 <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>
  62 </div>
  63 </body>
  64 </html>