doc/html/boost_asio/reference/io_context__work.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>io_context::work</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="io_context__strand/_strand.html" title="io_context::strand::~strand">
<link rel="next" href="io_context__work/get_io_context.html" title="io_context::work::get_io_context">
</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_context__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_context__work/get_io_context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.io_context__work"></a><a class="link" href="io_context__work.html" title="io_context::work">io_context::work</a>
</h3></div></div></div>
<p>
        (Deprecated: Use <a class="link" href="executor_work_guard.html" title="executor_work_guard"><code class="computeroutput">executor_work_guard</code></a>.)
        Class to inform the <a class="link" href="io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
        when it has work to do.
      </p>
<pre class="programlisting">class work
</pre>
<h5>
<a name="boost_asio.reference.io_context__work.h0"></a>
        <span class="phrase"><a name="boost_asio.reference.io_context__work.member_functions"></a></span><a class="link" href="io_context__work.html#boost_asio.reference.io_context__work.member_functions">Member Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="io_context__work/get_io_context.html" title="io_context::work::get_io_context"><span class="bold"><strong>get_io_context</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the io_context associated with the work.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="io_context__work/work.html" title="io_context::work::work"><span class="bold"><strong>work</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Constructor notifies the io_context that work is starting. <br>
                  <span class="silver"> &#8212;</span><br> Copy constructor notifies the io_context that work is starting.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="io_context__work/_work.html" title="io_context::work::~work"><span class="bold"><strong>~work</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Destructor notifies the io_context that the work is complete.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        The work class is used to inform the <a class="link" href="io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
        when work starts and finishes. This ensures that the <a class="link" href="io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
        object's <code class="computeroutput">run()</code> function will not exit while work is underway,
        and that it does exit when there is no unfinished work remaining.
      </p>
<p>
        The work class is copy-constructible so that it may be used as a data member
        in a handler class. It is not assignable.
      </p>
<h5>
<a name="boost_asio.reference.io_context__work.h1"></a>
        <span class="phrase"><a name="boost_asio.reference.io_context__work.requirements"></a></span><a class="link" href="io_context__work.html#boost_asio.reference.io_context__work.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/io_context.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></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 &#169; 2003-2019 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_context__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_context__work/get_io_context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>