summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/asio/src/doc/requirements/CompletionHandler.qbk
blob: 28d158b6cdda4f6b0b9d4f06b3cdc342c0124cad (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
62
63
[/
 / 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:CompletionHandler Completion handler requirements]

A completion handler must meet the requirements for a [link
asio.reference.Handler handler]. A value `h` of a completion handler
class should work correctly in the expression `h()`.

[heading Examples]

A free function as a completion handler:

  void completion_handler()
  {
    ...
  }

A completion handler function object:

  struct completion_handler
  {
    ...
    void operator()()
    {
      ...
    }
    ...
  };

A lambda as a completion handler:

  my_io_service.post(
      []()
      {
        ...
      });

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

  void my_class::completion_handler()
  {
    ...
  }
  ...
  my_io_service.post(std::bind(&my_class::completion_handler, this));

A non-static class member function adapted to a completion handler using
`boost::bind()`:

  void my_class::completion_handler()
  {
    ...
  }
  ...
  my_io_service.post(boost::bind(&my_class::completion_handler, this));

[endsect]