doc/html/boost_asio/reference/io_service__work.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>io_service::work</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="../reference.html" title="Reference">
   9 <link rel="prev" href="io_service__strand/_strand.html" title="io_service::strand::~strand">
  10 <link rel="next" href="io_service__work/get_io_service.html" title="io_service::work::get_io_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="io_service__strand/_strand.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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__work/get_io_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.io_service__work"></a><a class="link" href="io_service__work.html" title="io_service::work">io_service::work</a>
  28 </h3></div></div></div>
  29 <p>
  30         Class to inform the <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> when it has work to do.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">work</span>
  33 </pre>
  34 <h5>
  35 <a name="boost_asio.reference.io_service__work.h0"></a>
  36         <span class="phrase"><a name="boost_asio.reference.io_service__work.member_functions"></a></span><a class="link" href="io_service__work.html#boost_asio.reference.io_service__work.member_functions">Member Functions</a>
  37       </h5>
  38 <div class="informaltable"><table class="table">
  39 <colgroup>
  40 <col>
  41 <col>
  42 </colgroup>
  43 <thead><tr>
  44 <th>
  45                 <p>
  46                   Name
  47                 </p>
  48               </th>
  49 <th>
  50                 <p>
  51                   Description
  52                 </p>
  53               </th>
  54 </tr></thead>
  55 <tbody>
  56 <tr>
  57 <td>
  58                 <p>
  59                   <a class="link" href="io_service__work/get_io_service.html" title="io_service::work::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
  60                 </p>
  61               </td>
  62 <td>
  63                 <p>
  64                   Get the io_service associated with the work.
  65                 </p>
  66               </td>
  67 </tr>
  68 <tr>
  69 <td>
  70                 <p>
  71                   <a class="link" href="io_service__work/work.html" title="io_service::work::work"><span class="bold"><strong>work</strong></span></a>
  72                 </p>
  73               </td>
  74 <td>
  75                 <p>
  76                   Constructor notifies the io_service that work is starting.
  77                 </p>
  78                 <p>
  79                   Copy constructor notifies the io_service that work is starting.
  80                 </p>
  81               </td>
  82 </tr>
  83 <tr>
  84 <td>
  85                 <p>
  86                   <a class="link" href="io_service__work/_work.html" title="io_service::work::~work"><span class="bold"><strong>~work</strong></span></a>
  87                 </p>
  88               </td>
  89 <td>
  90                 <p>
  91                   Destructor notifies the io_service that the work is complete.
  92                 </p>
  93               </td>
  94 </tr>
  95 </tbody>
  96 </table></div>
  97 <p>
  98         The work class 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> when work starts and
  99         finishes. This ensures that 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">run</span><span class="special">()</span></code> function
 100         will not exit while work is underway, and that it does exit when there is
 101         no unfinished work remaining.
 102       </p>
 103 <p>
 104         The work class is copy-constructible so that it may be used as a data member
 105         in a handler class. It is not assignable.
 106       </p>
 107 <h5>
 108 <a name="boost_asio.reference.io_service__work.h1"></a>
 109         <span class="phrase"><a name="boost_asio.reference.io_service__work.requirements"></a></span><a class="link" href="io_service__work.html#boost_asio.reference.io_service__work.requirements">Requirements</a>
 110       </h5>
 111 <p>
 112         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/io_service.hpp</code>
 113       </p>
 114 <p>
 115         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 116       </p>
 117 </div>
 118 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 119 <td align="left"></td>
 120 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 121         Distributed under the Boost Software License, Version 1.0. (See accompanying
 122         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>)
 123       </p>
 124 </div></td>
 125 </tr></table>
 126 <hr>
 127 <div class="spirit-nav">
 128 <a accesskey="p" href="io_service__strand/_strand.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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__work/get_io_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 129 </div>
 130 </body>
 131 </html>