blob: 6cc8d8308d40fb2b7d8a0dc67c7b052fcd64303e (
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
51
52
53
54
55
|
[/
/ 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:AsyncWriteStream Buffer-oriented asynchronous write stream requirements]
In the table below, `a` denotes an asynchronous write stream object, `cb`
denotes an object satisfying [link boost_asio.reference.ConstBufferSequence
constant buffer sequence] requirements, and `h` denotes an object satisfying
[link boost_asio.reference.WriteHandler write handler] requirements.
[table Buffer-oriented asynchronous write stream requirements
[[operation] [type] [semantics, pre/post-conditions]]
[
[`a.get_io_service();`]
[`io_service&`]
[Returns the `io_service` object through which the `async_write_some`
handler `h` will be invoked.]
]
[
[`a.async_write_some(cb, h);`]
[`void`]
[
Initiates an asynchronous operation to write one or more bytes of data to
the stream `a`. 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 `async_write_some` 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 write operation is invoked,\n
\n
whichever comes first.\n
\n
If the total size of all buffers in the sequence `cb` is `0`, the
asynchronous write operation shall complete immediately and pass `0` as
the argument to the handler that specifies the number of bytes written.
]
]
]
[endsect]
|
