summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/src/doc/requirements/MoveAcceptHandler.qbk
blob: d545497fde69e9c6e961d5880c2a6ae19418945c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
[/
 / 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:MoveAcceptHandler Move accept handler requirements]

A move accept handler must meet the requirements for a [link
asio.reference.Handler handler]. A value `h` of a move accept 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 the nested type
`Protocol::socket` for the type `Protocol` of the socket class template.

[heading Examples]

A free function as a move accept handler:

  void accept_handler(
      const asio::error_code& ec, asio::ip::tcp::socket s)
  {
    ...
  }

A move accept handler function object:

  struct accept_handler
  {
    ...
    void operator()(
        const asio::error_code& ec, asio::ip::tcp::socket s)
    {
      ...
    }
    ...
  };

A lambda as a move accept handler:

  acceptor.async_accept(...,
      [](const asio::error_code& ec, asio::ip::tcp::socket s)
      {
        ...
      });

A non-static class member function adapted to a move accept handler using
`std::bind()`:

  void my_class::accept_handler(
      const asio::error_code& ec, asio::ip::tcp::socket socket)
  {
    ...
  }
  ...
  asio::async_accept(...,
      std::bind(&my_class::accept_handler,
        this, std::placeholders::_1,
        std::placeholders::_2));

[endsect]