summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/src/doc/requirements/BufferedHandshakeHandler.qbk
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/asio/src/doc/requirements/BufferedHandshakeHandler.qbk')
-rw-r--r--3rdparty/asio/src/doc/requirements/BufferedHandshakeHandler.qbk55
1 files changed, 55 insertions, 0 deletions
diff --git a/3rdparty/asio/src/doc/requirements/BufferedHandshakeHandler.qbk b/3rdparty/asio/src/doc/requirements/BufferedHandshakeHandler.qbk
new file mode 100644
index 00000000000..6e6bbf231c3
--- /dev/null
+++ b/3rdparty/asio/src/doc/requirements/BufferedHandshakeHandler.qbk
@@ -0,0 +1,55 @@
+[/
+ / Copyright (c) 2003-2016 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
+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 asio::error_code& ec,
+ std::size_t bytes_transferred)
+ {
+ ...
+ }
+
+A buffered handshake handler function object:
+
+ struct handshake_handler
+ {
+ ...
+ void operator()(
+ const asio::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 asio::error_code& ec,
+ std::size_t bytes_transferred)
+ {
+ ...
+ }
+ ...
+ socket.async_handshake(...,
+ boost::bind(&my_class::handshake_handler,
+ this, asio::placeholders::error,
+ asio::placeholders::bytes_transferred));
+
+[endsect]