diff options
Diffstat (limited to '3rdparty/asio/src/doc/requirements/WaitHandler.qbk')
-rw-r--r-- | 3rdparty/asio/src/doc/requirements/WaitHandler.qbk | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/3rdparty/asio/src/doc/requirements/WaitHandler.qbk b/3rdparty/asio/src/doc/requirements/WaitHandler.qbk new file mode 100644 index 00000000000..a7135f07369 --- /dev/null +++ b/3rdparty/asio/src/doc/requirements/WaitHandler.qbk @@ -0,0 +1,72 @@ +[/ + / 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:WaitHandler Wait handler requirements] + +A wait handler must meet the requirements for a [link +asio.reference.Handler handler]. A value `h` of a wait handler class +should work correctly in the expression `h(ec)`, where `ec` is an lvalue of +type `const error_code`. + +[heading Examples] + +A free function as a wait handler: + + void wait_handler( + const asio::error_code& ec) + { + ... + } + +A wait handler function object: + + struct wait_handler + { + ... + void operator()( + const asio::error_code& ec) + { + ... + } + ... + }; + +A lambda as a wait handler: + + socket.async_wait(..., + [](const asio::error_code& ec) + { + ... + }); + +A non-static class member function adapted to a wait handler using +`std::bind()`: + + void my_class::wait_handler( + const asio::error_code& ec) + { + ... + } + ... + socket.async_wait(..., + std::bind(&my_class::wait_handler, + this, std::placeholders::_1)); + +A non-static class member function adapted to a wait handler using +`boost::bind()`: + + void my_class::wait_handler( + const asio::error_code& ec) + { + ... + } + ... + socket.async_wait(..., + boost::bind(&my_class::wait_handler, + this, asio::placeholders::error)); + +[endsect] |