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
133
134
135
136
137
138
139
|
[/
/ Copyright (c) 2003-2014 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:StreamSocketService Stream socket service requirements]
A stream socket service must meet the requirements for a [link
boost_asio.reference.SocketService socket service], as well as the additional
requirements listed below.
In the table below, `X` denotes a stream socket service class, `a` denotes a
value of type `X`, `b` denotes a value of type `X::implementation_type`, `ec`
denotes a value of type `error_code`, `f` denotes a value of type
`socket_base::message_flags`, `mb` denotes a value satisfying [link
boost_asio.reference.MutableBufferSequence mutable buffer sequence]
requirements, `rh` denotes a value meeting [link
boost_asio.reference.ReadHandler `ReadHandler`] requirements, `cb` denotes a
value satisfying [link boost_asio.reference.ConstBufferSequence constant
buffer sequence] requirements, and `wh` denotes a value meeting [link
boost_asio.reference.WriteHandler `WriteHandler`] requirements.
[table StreamSocketService requirements
[[expression] [return type] [assertion/note\npre/post-condition]]
[
[`a.receive(b, mb, f, ec);`]
[`size_t`]
[
pre: `a.is_open(b)`.\n
\n
Reads one or more bytes of data from a connected socket `b`.\n
\n
The mutable buffer sequence `mb` specifies memory where the data should
be placed. The operation shall always fill a buffer in the sequence
completely before proceeding to the next.\n
\n
If successful, returns the number of bytes read. Otherwise returns `0`.
If the total size of all buffers in the sequence `mb` is `0`, the
function shall return `0` immediately.\n
\n
If the operation completes due to graceful connection closure by the
peer, the operation shall fail with `error::eof`.
]
]
[
[`a.async_receive(b, mb, f, rh);`]
[`void`]
[
pre: `a.is_open(b)`.\n
\n
Initiates an asynchronous operation to read one or more bytes of data
from a connected socket `b`. The operation is performed via the
`io_service` object `a.get_io_service()` and behaves according to [link
boost_asio.reference.asynchronous_operations asynchronous operation]
requirements.\n
\n
The mutable buffer sequence `mb` specifies memory where the data should
be placed. The operation shall always fill a buffer in the sequence
completely before proceeding to the next.\n
\n
The implementation shall maintain one or more copies of `mb` until such
time as the read operation no longer requires access to the memory
specified by the buffers in the sequence. The program must ensure the
memory is valid until:\n
\n
[mdash] the last copy of `mb` is destroyed, or\n
\n
[mdash] the handler for the asynchronous operation is invoked,\n
\n
whichever comes first. If the total size of all buffers in the sequence
`mb` is `0`, the asynchronous read operation shall complete immediately
and pass `0` as the argument to the handler that specifies the number of
bytes read.\n
\n
If the operation completes due to graceful connection closure by the
peer, the operation shall fail with `error::eof`.\n
\n
If the operation completes successfully, the `ReadHandler` object
`rh` is invoked with the number of bytes transferred. Otherwise it is
invoked with `0`.
]
]
[
[`a.send(b, cb, f, ec);`]
[`size_t`]
[
pre: `a.is_open(b)`.\n
\n
Writes one or more bytes of data to a connected socket `b`.\n
\n
The constant buffer sequence `cb` specifies memory where the data to be
written is located. The operation shall always write a buffer in the
sequence completely before proceeding to the next.\n
\n
If successful, returns the number of bytes written. Otherwise returns `0`.
If the total size of all buffers in the sequence `cb` is `0`, the
function shall return `0` immediately.
]
]
[
[`a.async_send(b, cb, f, wh);`]
[`void`]
[
pre: `a.is_open(b)`.\n
\n
Initiates an asynchronous operation to write one or more bytes of data to
a connected socket `b`. The operation is performed via the `io_service`
object `a.get_io_service()` and behaves according to [link
boost_asio.reference.asynchronous_operations asynchronous operation]
requirements.\n
\n
The constant buffer sequence `cb` specifies memory where the data to be
written is located. The operation shall always write a buffer in the
sequence completely before proceeding to the next.\n
\n
The implementation shall maintain one or more copies of `cb` until such
time as the write operation no longer requires access to the memory
specified by the buffers in the sequence. The program must ensure the
memory is valid until:\n
\n
[mdash] the last copy of `cb` is destroyed, or\n
\n
[mdash] the handler for the asynchronous operation is invoked,\n
\n
whichever comes first. If the total size of all buffers in the sequence
`cb` is `0`, the asynchronous operation shall complete immediately and
pass `0` as the argument to the handler that specifies the number of
bytes read.\n
\n
If the operation completes successfully, the `WriteHandler` object `wh`
is invoked with the number of bytes transferred. Otherwise it is invoked
with `0`.
]
]
]
[endsect]
|
