• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Buffered handshake handler requirements</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="AsyncWriteStream.html" title="Buffer-oriented asynchronous write stream requirements">
10<link rel="next" href="CompletionCondition.html" title="Completion condition requirements">
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="AsyncWriteStream.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="CompletionCondition.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.BufferedHandshakeHandler"></a><a class="link" href="BufferedHandshakeHandler.html" title="Buffered handshake handler requirements">Buffered
28      handshake handler requirements</a>
29</h3></div></div></div>
30<p>
31        A buffered handshake handler must meet the requirements for a <a class="link" href="Handler.html" title="Handlers">handler</a>.
32        A value <code class="computeroutput">h</code> of a buffered handshake handler class should work
33        correctly in the expression <code class="computeroutput">h(ec, s)</code>, where <code class="computeroutput">ec</code>
34        is an lvalue of type <code class="computeroutput">const error_code</code> and <code class="computeroutput">s</code> is
35        an lvalue of type <code class="computeroutput">const size_t</code>.
36      </p>
37<h5>
38<a name="boost_asio.reference.BufferedHandshakeHandler.h0"></a>
39        <span class="phrase"><a name="boost_asio.reference.BufferedHandshakeHandler.examples"></a></span><a class="link" href="BufferedHandshakeHandler.html#boost_asio.reference.BufferedHandshakeHandler.examples">Examples</a>
40      </h5>
41<p>
42        A free function as a buffered handshake handler:
43      </p>
44<pre class="programlisting">void handshake_handler(
45    const boost::system::error_code&amp; ec,
46    std::size_t bytes_transferred)
47{
48  ...
49}
50</pre>
51<p>
52        A buffered handshake handler function object:
53      </p>
54<pre class="programlisting">struct handshake_handler
55{
56  ...
57  void operator()(
58      const boost::system::error_code&amp; ec,
59      std::size_t bytes_transferred)
60  {
61    ...
62  }
63  ...
64};
65</pre>
66<p>
67        A non-static class member function adapted to a buffered handshake handler
68        using <code class="computeroutput">boost::bind()</code>:
69      </p>
70<pre class="programlisting">void my_class::handshake_handler(
71    const boost::system::error_code&amp; ec,
72    std::size_t bytes_transferred)
73{
74  ...
75}
76...
77socket.async_handshake(...,
78    boost::bind(&amp;my_class::handshake_handler,
79      this, boost::asio::placeholders::error,
80      boost::asio::placeholders::bytes_transferred));
81</pre>
82</div>
83<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
84<td align="left"></td>
85<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
86      Kohlhoff<p>
87        Distributed under the Boost Software License, Version 1.0. (See accompanying
88        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>)
89      </p>
90</div></td>
91</tr></table>
92<hr>
93<div class="spirit-nav">
94<a accesskey="p" href="AsyncWriteStream.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="CompletionCondition.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
95</div>
96</body>
97</html>
98