read.html
15 KB
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>read</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="query_result/type.html" title="query_result::type">
<link rel="next" href="read/overload1.html" title="read (1 of 16 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="query_result/type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="read/overload1.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.read"></a><a class="link" href="read.html" title="read">read</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.read"></a>
The <code class="computeroutput">read</code> function is a composed operation
that reads a certain amount of data from a stream before returning.
</p>
<p>
Attempt to read a certain amount of data from a stream before returning.
</p>
<pre class="programlisting">template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>>
std::size_t <a class="link" href="read/overload1.html" title="read (1 of 16 overloads)">read</a>(
SyncReadStream & s,
const MutableBufferSequence & buffers,
typename enable_if< is_mutable_buffer_sequence< MutableBufferSequence >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload1.html" title="read (1 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>>
std::size_t <a class="link" href="read/overload2.html" title="read (2 of 16 overloads)">read</a>(
SyncReadStream & s,
const MutableBufferSequence & buffers,
asio::error_code & ec,
typename enable_if< is_mutable_buffer_sequence< MutableBufferSequence >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload2.html" title="read (2 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload3.html" title="read (3 of 16 overloads)">read</a>(
SyncReadStream & s,
const MutableBufferSequence & buffers,
CompletionCondition completion_condition,
typename enable_if< is_mutable_buffer_sequence< MutableBufferSequence >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload3.html" title="read (3 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload4.html" title="read (4 of 16 overloads)">read</a>(
SyncReadStream & s,
const MutableBufferSequence & buffers,
CompletionCondition completion_condition,
asio::error_code & ec,
typename enable_if< is_mutable_buffer_sequence< MutableBufferSequence >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload4.html" title="read (4 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
std::size_t <a class="link" href="read/overload5.html" title="read (5 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v1 && buffers,
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload5.html" title="read (5 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>>
std::size_t <a class="link" href="read/overload6.html" title="read (6 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v1 && buffers,
asio::error_code & ec,
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload6.html" title="read (6 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload7.html" title="read (7 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v1 && buffers,
CompletionCondition completion_condition,
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload7.html" title="read (7 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload8.html" title="read (8 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v1 && buffers,
CompletionCondition completion_condition,
asio::error_code & ec,
typename enable_if< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value &&!is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload8.html" title="read (8 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename Allocator>
std::size_t <a class="link" href="read/overload9.html" title="read (9 of 16 overloads)">read</a>(
SyncReadStream & s,
basic_streambuf< Allocator > & b);
<span class="emphasis"><em>» <a class="link" href="read/overload9.html" title="read (9 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename Allocator>
std::size_t <a class="link" href="read/overload10.html" title="read (10 of 16 overloads)">read</a>(
SyncReadStream & s,
basic_streambuf< Allocator > & b,
asio::error_code & ec);
<span class="emphasis"><em>» <a class="link" href="read/overload10.html" title="read (10 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename Allocator,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload11.html" title="read (11 of 16 overloads)">read</a>(
SyncReadStream & s,
basic_streambuf< Allocator > & b,
CompletionCondition completion_condition);
<span class="emphasis"><em>» <a class="link" href="read/overload11.html" title="read (11 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename Allocator,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload12.html" title="read (12 of 16 overloads)">read</a>(
SyncReadStream & s,
basic_streambuf< Allocator > & b,
CompletionCondition completion_condition,
asio::error_code & ec);
<span class="emphasis"><em>» <a class="link" href="read/overload12.html" title="read (12 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
std::size_t <a class="link" href="read/overload13.html" title="read (13 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v2 buffers,
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload13.html" title="read (13 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
std::size_t <a class="link" href="read/overload14.html" title="read (14 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v2 buffers,
asio::error_code & ec,
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload14.html" title="read (14 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload15.html" title="read (15 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v2 buffers,
CompletionCondition completion_condition,
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload15.html" title="read (15 of 16 overloads)">more...</a></em></span>
template<
typename <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>>
std::size_t <a class="link" href="read/overload16.html" title="read (16 of 16 overloads)">read</a>(
SyncReadStream & s,
DynamicBuffer_v2 buffers,
CompletionCondition completion_condition,
asio::error_code & ec,
typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0);
<span class="emphasis"><em>» <a class="link" href="read/overload16.html" title="read (16 of 16 overloads)">more...</a></em></span>
</pre>
<h5>
<a name="asio.reference.read.h0"></a>
<span><a name="asio.reference.read.requirements"></a></span><a class="link" href="read.html#asio.reference.read.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/read.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="query_result/type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="read/overload1.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>