summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/src/doc/requirements/RangeConnectHandler.qbk
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/asio/src/doc/requirements/RangeConnectHandler.qbk')
-rw-r--r--3rdparty/asio/src/doc/requirements/RangeConnectHandler.qbk82
1 files changed, 82 insertions, 0 deletions
diff --git a/3rdparty/asio/src/doc/requirements/RangeConnectHandler.qbk b/3rdparty/asio/src/doc/requirements/RangeConnectHandler.qbk
new file mode 100644
index 00000000000..4300af1003b
--- /dev/null
+++ b/3rdparty/asio/src/doc/requirements/RangeConnectHandler.qbk
@@ -0,0 +1,82 @@
+[/
+ / 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:RangeConnectHandler Range connect handler requirements]
+
+A range connect handler must meet the requirements for a [link
+asio.reference.Handler handler]. A value `h` of a range connect handler class
+should work correctly in the expression `h(ec, ep)`, where `ec` is an lvalue of
+type `const error_code` and `ep` is an lvalue of the type `Protocol::endpoint`
+for the `Protocol` type in the corresponding `connect()` or async_connect()`
+function.
+
+[heading Examples]
+
+A free function as a range connect handler:
+
+ void connect_handler(
+ const asio::error_code& ec,
+ const asio::ip::tcp::endpoint& endpoint)
+ {
+ ...
+ }
+
+A range connect handler function object:
+
+ struct connect_handler
+ {
+ ...
+ template <typename Range>
+ void operator()(
+ const asio::error_code& ec,
+ const asio::ip::tcp::endpoint& endpoint)
+ {
+ ...
+ }
+ ...
+ };
+
+A lambda as a range connect handler:
+
+ asio::async_connect(...,
+ [](const asio::error_code& ec,
+ const asio::ip::tcp::endpoint& endpoint)
+ {
+ ...
+ });
+
+A non-static class member function adapted to a range connect handler using
+`std::bind()`:
+
+ void my_class::connect_handler(
+ const asio::error_code& ec,
+ const asio::ip::tcp::endpoint& endpoint)
+ {
+ ...
+ }
+ ...
+ asio::async_connect(...,
+ std::bind(&my_class::connect_handler,
+ this, std::placeholders::_1,
+ std::placeholders::_2));
+
+A non-static class member function adapted to a range connect handler using
+`boost::bind()`:
+
+ void my_class::connect_handler(
+ const asio::error_code& ec,
+ const asio::ip::tcp::endpoint& endpoint)
+ {
+ ...
+ }
+ ...
+ asio::async_connect(...,
+ boost::bind(&my_class::connect_handler,
+ this, asio::placeholders::error,
+ asio::placeholders::endpoint));
+
+[endsect]