127 lines
5.7 KiB
HTML
127 lines
5.7 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>io_context::work</title>
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
|
<link rel="home" href="../../index.html" title="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="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="io_context__strand/_strand.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="io_context__work/get_io_context.html"><img src="../../next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="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="asio.reference.io_context__work.h0"></a>
|
|
<span><a name="asio.reference.io_context__work.member_functions"></a></span><a class="link" href="io_context__work.html#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> <span class="silver">[constructor]</span>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Constructor notifies the io_context that work is starting. <br>
|
|
<span class="silver"> —</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> <span class="silver">[destructor]</span>
|
|
</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="asio.reference.io_context__work.h1"></a>
|
|
<span><a name="asio.reference.io_context__work.requirements"></a></span><a class="link" href="io_context__work.html#asio.reference.io_context__work.requirements">Requirements</a>
|
|
</h5>
|
|
<p>
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/io_context.hpp</code>
|
|
</p>
|
|
<p>
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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 © 2003-2020 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="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="io_context__work/get_io_context.html"><img src="../../next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|