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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
[/
/ 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:HandleService Handle service requirements]
A handle service must meet the requirements for an [link
boost_asio.reference.IoObjectService I/O object service] with support for movability,
as well as the additional requirements listed below.
In the table below, `X` denotes a handle service class, `a` and `ao` denote
values of type `X`, `b` and `c` denote values of type `X::implementation_type`,
`n` denotes a value of type `X::native_handle_type`, `ec` denotes a value of
type `error_code`, and `u` and `v` denote identifiers.
[table HandleService requirements
[[expression] [return type] [assertion/note\npre/post-condition]]
[
[`X::native_handle_type`]
[]
[
The implementation-defined native representation of a handle. Must
satisfy the requirements of `CopyConstructible` types (C++ Std, 20.1.3),
and the requirements of `Assignable` types (C++ Std, 23.1).
]
]
[
[`a.construct(b);`]
[]
[
From [link boost_asio.reference.IoObjectService IoObjectService]
requirements.\n
post: `!a.is_open(b)`.
]
]
[
[`a.destroy(b);`]
[]
[
From [link boost_asio.reference.IoObjectService IoObjectService]
requirements. Implicitly cancels asynchronous operations, as if by calling
`a.close(b, ec)`.
]
]
[
[``
a.move_construct(b, c);
``]
[]
[
From [link boost_asio.reference.IoObjectService IoObjectService] requirements.
The underlying native representation is moved from `c` to `b`.
]
]
[
[``
a.move_assign(b, ao, c);
``]
[]
[
From [link boost_asio.reference.IoObjectService IoObjectService] requirements.
Implicitly cancels asynchronous operations associated with `b`, as if by
calling `a.close(b, ec)`. Then the underlying native representation is
moved from `c` to `b`.
]
]
[
[``
a.assign(b, n, ec);
``]
[`error_code`]
[
pre: `!a.is_open(b)`.\n
post: `!!ec || a.is_open(b)`.
]
]
[
[``
a.is_open(b);
``]
[`bool`]
[
]
]
[
[``
const X& u = a;
const X::implementation_type& v = b;
u.is_open(v);
``]
[`bool`]
[
]
]
[
[``
a.close(b, ec);
``]
[`error_code`]
[
If `a.is_open()` is true, causes any outstanding asynchronous operations
to complete as soon as possible. Handlers for cancelled operations shall
be passed the error code `error::operation_aborted`.\n
post: `!a.is_open(b)`.
]
]
[
[``
a.native_handle(b);
``]
[`X::native_handle_type`]
[
]
]
[
[``
a.cancel(b, ec);
``]
[`error_code`]
[
pre: `a.is_open(b)`.\n
Causes any outstanding asynchronous operations to complete as soon as
possible. Handlers for cancelled operations shall be passed the error
code `error::operation_aborted`.
]
]
]
[endsect]
|
