blob: 2eac0f1da401639160fe4610d9da96876b1e9fdd (
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
|
[/
/ 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:SyncReadStream Buffer-oriented synchronous read stream requirements]
In the table below, `a` denotes a synchronous read stream object, `mb` denotes
an object satisfying [link boost_asio.reference.MutableBufferSequence
mutable buffer sequence] requirements, and `ec` denotes an object of type
`error_code`.
[table Buffer-oriented synchronous read stream requirements
[[operation] [type] [semantics, pre/post-conditions]]
[
[`a.read_some(mb);`]
[`size_t`]
[Equivalent to:
``
error_code ec;
size_t s = a.read_some(mb, ec);
if (ec) throw system_error(ec);
return s;
``]
]
[
[`a.read_some(mb, ec);`]
[`size_t`]
[
Reads one or more bytes of data from the stream `a`.\n
\n
The mutable buffer sequence `mb` specifies memory where the data should
be placed. The `read_some` 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 and sets `ec` such that
`!ec` is true. If an error occurred, returns `0` and sets `ec` such that
`!!ec` is true.\n
\n
If the total size of all buffers in the sequence `mb` is `0`, the
function shall return `0` immediately.
]
]
]
[endsect]
|
