boost/doc/html/boost_asio/reference/WaitHandler.html
2021-10-05 21:37:46 +02:00

113 lines
4.7 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Wait handler requirements</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="TimeTraits.html" title="Time traits requirements">
<link rel="next" href="WaitTraits.html" title="Wait traits requirements">
</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="TimeTraits.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="WaitTraits.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.WaitHandler"></a><a class="link" href="WaitHandler.html" title="Wait handler requirements">Wait handler requirements</a>
</h3></div></div></div>
<p>
A wait handler must meet the requirements for a <a class="link" href="Handler.html" title="Handlers">handler</a>.
A value <code class="computeroutput">h</code> of a wait handler class should work correctly in the
expression <code class="computeroutput">h(ec)</code>, where <code class="computeroutput">ec</code> is an lvalue of type
<code class="computeroutput">const error_code</code>.
</p>
<h5>
<a name="boost_asio.reference.WaitHandler.h0"></a>
<span class="phrase"><a name="boost_asio.reference.WaitHandler.examples"></a></span><a class="link" href="WaitHandler.html#boost_asio.reference.WaitHandler.examples">Examples</a>
</h5>
<p>
A free function as a wait handler:
</p>
<pre class="programlisting">void wait_handler(
const boost::system::error_code&amp; ec)
{
...
}
</pre>
<p>
A wait handler function object:
</p>
<pre class="programlisting">struct wait_handler
{
...
void operator()(
const boost::system::error_code&amp; ec)
{
...
}
...
};
</pre>
<p>
A lambda as a wait handler:
</p>
<pre class="programlisting">socket.async_wait(...,
[](const boost::system::error_code&amp; ec)
{
...
});
</pre>
<p>
A non-static class member function adapted to a wait handler using <code class="computeroutput">std::bind()</code>:
</p>
<pre class="programlisting">void my_class::wait_handler(
const boost::system::error_code&amp; ec)
{
...
}
...
socket.async_wait(...,
std::bind(&amp;my_class::wait_handler,
this, std::placeholders::_1));
</pre>
<p>
A non-static class member function adapted to a wait handler using <code class="computeroutput">boost::bind()</code>:
</p>
<pre class="programlisting">void my_class::wait_handler(
const boost::system::error_code&amp; ec)
{
...
}
...
socket.async_wait(...,
boost::bind(&amp;my_class::wait_handler,
this, boost::asio::placeholders::error));
</pre>
</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-2021 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="TimeTraits.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="WaitTraits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>