asio/doc/requirements/BufferedHandshakeHandler.qbk
2019-02-17 19:59:39 -10:00

56 lines
1.4 KiB
Plaintext

[/
/ Copyright (c) 2003-2019 Christopher M. Kohlhoff (chris at kohlhoff dot com)
/
/ Distributed under the Boost Software License, Version 1.0. (See accompanying
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
[section:BufferedHandshakeHandler Buffered handshake handler requirements]
A buffered handshake handler must meet the requirements for a [link
boost_asio.reference.Handler handler]. A value `h` of a buffered handshake handler
class should work correctly in the expression `h(ec, s)`, where `ec` is an
lvalue of type `const error_code` and `s` is an lvalue of type `const size_t`.
[heading Examples]
A free function as a buffered handshake handler:
void handshake_handler(
const boost::system::error_code& ec,
std::size_t bytes_transferred)
{
...
}
A buffered handshake handler function object:
struct handshake_handler
{
...
void operator()(
const boost::system::error_code& ec,
std::size_t bytes_transferred)
{
...
}
...
};
A non-static class member function adapted to a buffered handshake handler
using `boost::bind()`:
void my_class::handshake_handler(
const boost::system::error_code& ec,
std::size_t bytes_transferred)
{
...
}
...
socket.async_handshake(...,
boost::bind(&my_class::handshake_handler,
this, boost::asio::placeholders::error,
boost::asio::placeholders::bytes_transferred));
[endsect]