summaryrefslogtreecommitdiff
path: root/libs/asio/doc/requirements/ShutdownHandler.qbk
blob: 6426a6cdf9a7b31bebd86899aeb99ed42a9a0404 (plain)
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
[/
 / Copyright (c) 2003-2015 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:ShutdownHandler SSL shutdown handler requirements]

A shutdown handler must meet the requirements for a [link
boost_asio.reference.Handler handler]. A value `h` of a shutdown 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 shutdown handler:

  void shutdown_handler(
      const boost::system::error_code& ec)
  {
    ...
  }

A shutdown handler function object:

  struct shutdown_handler
  {
    ...
    void operator()(
        const boost::system::error_code& ec)
    {
      ...
    }
    ...
  };

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

  void my_class::shutdown_handler(
      const boost::system::error_code& ec)
  {
    ...
  }
  ...
  ssl_stream.async_shutdown(
      boost::bind(&my_class::shutdown_handler,
        this, boost::asio::placeholders::error));

[endsect]