overload1.html
6.36 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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>write_at (1 of 8 overloads)</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="../write_at.html" title="write_at">
<link rel="prev" href="../write_at.html" title="write_at">
<link rel="next" href="overload2.html" title="write_at (2 of 8 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="../write_at.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write_at.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="overload2.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.write_at.overload1"></a><a class="link" href="overload1.html" title="write_at (1 of 8 overloads)">write_at (1 of 8
overloads)</a>
</h4></div></div></div>
<p>
Write all of the supplied data at the specified offset before returning.
</p>
<pre class="programlisting">template<
typename <a class="link" href="../SyncRandomAccessWriteDevice.html" title="Buffer-oriented synchronous random-access write device requirements">SyncRandomAccessWriteDevice</a>,
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>>
std::size_t write_at(
SyncRandomAccessWriteDevice & d,
uint64_t offset,
const ConstBufferSequence & buffers);
</pre>
<p>
This function is used to write a certain number of bytes of data to a random
access device at a specified offset. The call will block until one of the
following conditions is true:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
All of the data in the supplied buffers has been written. That is,
the bytes transferred is equal to the sum of the buffer sizes.
</li>
<li class="listitem">
An error occurred.
</li>
</ul></div>
<p>
This operation is implemented in terms of zero or more calls to the device's
write_some_at function.
</p>
<h6>
<a name="asio.reference.write_at.overload1.h0"></a>
<span><a name="asio.reference.write_at.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.write_at.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">d</span></dt>
<dd><p>
The device to which the data is to be written. The type must support
the SyncRandomAccessWriteDevice concept.
</p></dd>
<dt><span class="term">offset</span></dt>
<dd><p>
The offset at which the data will be written.
</p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more buffers containing the data to be written. The sum of
the buffer sizes indicates the maximum number of bytes to write to
the device.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.write_at.overload1.h1"></a>
<span><a name="asio.reference.write_at.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.write_at.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of bytes transferred.
</p>
<h6>
<a name="asio.reference.write_at.overload1.h2"></a>
<span><a name="asio.reference.write_at.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.write_at.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.write_at.overload1.h3"></a>
<span><a name="asio.reference.write_at.overload1.example"></a></span><a class="link" href="overload1.html#asio.reference.write_at.overload1.example">Example</a>
</h6>
<p>
To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
function as follows:
</p>
<pre class="programlisting">asio::write_at(d, 42, asio::buffer(data, size));
</pre>
<p>
See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on writing multiple buffers in one go, and
how to use it with arrays, boost::array or std::vector.
</p>
<h6>
<a name="asio.reference.write_at.overload1.h4"></a>
<span><a name="asio.reference.write_at.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.write_at.overload1.remarks">Remarks</a>
</h6>
<p>
This overload is equivalent to calling:
</p>
<pre class="programlisting">asio::write_at(
d, offset, buffers,
asio::transfer_all());
</pre>
</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="../write_at.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write_at.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="overload2.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>