2 / Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
4 / Distributed under the Boost Software License, Version 1.0. (See accompanying
5 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
8 [section:SignalSetService Signal set service requirements]
10 A signal set service must meet the requirements for an [link
11 boost_asio.reference.IoObjectService I/O object service], as well as the
12 additional requirements listed below.
14 In the table below, `X` denotes a signal set service class, `a` denotes a value
15 of type `X`, `b` denotes a value of type `X::implementation_type`, `ec` denotes
16 a value of type `error_code`, `n` denotes a value of type `int`, and `sh`
17 denotes a value meeting [link boost_asio.reference.SignalHandler `SignalHandler`]
20 [table SignalSetService requirements
21 [[expression] [return type] [assertion/note\npre/post-condition]]
26 From [link boost_asio.reference.IoObjectService IoObjectService]
34 From [link boost_asio.reference.IoObjectService IoObjectService]
35 requirements. Implicitly clears the registered signals as if by calling
36 `a.clear(b, ec)`, then implicitly cancels outstanding asynchronous
37 operations as if by calling `a.cancel(b, ec)`.
73 [`a.async_wait(b, sh);`]
76 pre: `a.is_open(b)`.\n
78 Initiates an asynchronous operation to wait for the delivery of one of the
79 signals registered for the signal set `b`. The operation is performed via
80 the `io_service` object `a.get_io_service()` and behaves according to
81 [link boost_asio.reference.asynchronous_operations asynchronous operation]
84 If the operation completes successfully, the `SignalHandler` object
85 `sh` is invoked with the number identifying the delivered signal. Otherwise
86 it is invoked with `0`.