DynamicBuffer_v1.html
10 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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dynamic buffer requirements (version 1)</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="DynamicBuffer.html" title="Dynamic buffer requirements">
<link rel="next" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">
</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="DynamicBuffer.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="DynamicBuffer_v2.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.DynamicBuffer_v1"></a><a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">Dynamic buffer requirements
(version 1)</a>
</h3></div></div></div>
<p>
A dynamic buffer encapsulates memory storage that may be automatically resized
as required, where the memory is divided into an input sequence followed
by an output sequence. These memory regions are internal to the dynamic buffer
sequence, but direct access to the elements is provided to permit them to
be efficiently used with I/O operations, such as the <code class="computeroutput">send</code> or
<code class="computeroutput">receive</code> operations of a socket. Data written to the output sequence
of a dynamic buffer sequence object is appended to the input sequence of
the same object.
</p>
<p>
A dynamic buffer type <code class="computeroutput">X</code> shall satisfy the requirements of <code class="computeroutput">MoveConstructible</code>
(C++ Std, [moveconstructible]) types in addition to those listed below.
</p>
<p>
In the table below, <code class="computeroutput">X</code> denotes a dynamic buffer class, <code class="computeroutput">x</code>
denotes a value of type <code class="computeroutput">X&</code>, <code class="computeroutput">x1</code> denotes values
of type <code class="computeroutput">const X&</code>, and <code class="computeroutput">n</code> denotes a value of
type <code class="computeroutput">size_t</code>, and <code class="computeroutput">u</code> denotes an identifier.
</p>
<div class="table">
<a name="asio.reference.DynamicBuffer_v1.t0"></a><p class="title"><b>Table 9. DynamicBuffer_v1 requirements</b></p>
<div class="table-contents"><table class="table" summary="DynamicBuffer_v1 requirements">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
expression
</p>
</th>
<th>
<p>
type
</p>
</th>
<th>
<p>
assertion/note<br> pre/post-conditions
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput">X::const_buffers_type</code>
</p>
</td>
<td>
<p>
type meeting <a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>
requirements.
</p>
</td>
<td>
<p>
This type represents the memory associated with the input sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">X::mutable_buffers_type</code>
</p>
</td>
<td>
<p>
type meeting <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>
requirements.
</p>
</td>
<td>
<p>
This type represents the memory associated with the output sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x1.size()</code>
</p>
</td>
<td>
<p>
<code class="computeroutput">size_t</code>
</p>
</td>
<td>
<p>
Returns the size, in bytes, of the input sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x1.max_size()</code>
</p>
</td>
<td>
<p>
<code class="computeroutput">size_t</code>
</p>
</td>
<td>
<p>
Returns the permitted maximum of the sum of the sizes of the input
sequence and output sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x1.capacity()</code>
</p>
</td>
<td>
<p>
<code class="computeroutput">size_t</code>
</p>
</td>
<td>
<p>
Returns the maximum sum of the sizes of the input sequence and
output sequence that the dynamic buffer can hold without requiring
reallocation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x1.data()</code>
</p>
</td>
<td>
<p>
<code class="computeroutput">X::const_buffers_type</code>
</p>
</td>
<td>
<p>
Returns a constant buffer sequence <code class="computeroutput">u</code> that represents
the memory associated with the input sequence, and where <code class="computeroutput">buffer_size(u)
== size()</code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x.prepare(n)</code>
</p>
</td>
<td>
<p>
<code class="computeroutput">X::mutable_buffers_type</code>
</p>
</td>
<td>
<p>
Requires: <code class="computeroutput">size() + n <= max_size()</code>.<br> <br>
Returns a mutable buffer sequence <code class="computeroutput">u</code> representing the
output sequence, and where <code class="computeroutput">buffer_size(u) == n</code>. The
dynamic buffer reallocates memory as required. All constant or
mutable buffer sequences previously obtained using <code class="computeroutput">data()</code>
or <code class="computeroutput">prepare()</code> are invalidated.<br> <br> Throws:
<code class="computeroutput">length_error</code> if <code class="computeroutput">size() + n > max_size()</code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x.commit(n)</code>
</p>
</td>
<td>
</td>
<td>
<p>
Appends <code class="computeroutput">n</code> bytes from the start of the output sequence
to the end of the input sequence. The remainder of the output sequence
is discarded. If <code class="computeroutput">n</code> is greater than the size of the
output sequence, the entire output sequence is appended to the
input sequence. All constant or mutable buffer sequences previously
obtained using <code class="computeroutput">data()</code> or <code class="computeroutput">prepare()</code> are
invalidated.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput">x.consume(n)</code>
</p>
</td>
<td>
</td>
<td>
<p>
Removes <code class="computeroutput">n</code> bytes from beginning of the input sequence.
If <code class="computeroutput">n</code> is greater than the size of the input sequence,
the entire input sequence is removed. All constant or mutable buffer
sequences previously obtained using <code class="computeroutput">data()</code> or <code class="computeroutput">prepare()</code>
are invalidated.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</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="DynamicBuffer.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="DynamicBuffer_v2.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>