summaryrefslogtreecommitdiff
path: root/doc/html/boost_asio/reference/read_write_operations.html
blob: 340411a142e42f67ad65f69ae2f45c5436eec56d (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Requirements on read and write operations</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="asynchronous_operations.html" title="Requirements on asynchronous operations">
<link rel="next" href="synchronous_socket_operations.html" title="Requirements on synchronous socket operations">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="asynchronous_operations.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="synchronous_socket_operations.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.read_write_operations"></a><a class="link" href="read_write_operations.html" title="Requirements on read and write operations">Requirements
      on read and write operations</a>
</h3></div></div></div>
<p>
        A <span class="emphasis"><em>read operation</em></span> is an operation that reads data into
        a mutable buffer sequence argument of a type meeting <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements"><code class="computeroutput">MutableBufferSequence</code></a>
        requirements. The mutable buffer sequence specifies memory where the data
        should be placed. A read operation shall always fill a buffer in the sequence
        completely before proceeding to the next.
      </p>
<p>
        A <span class="emphasis"><em>write operation</em></span> is an operation that writes data from
        a constant buffer sequence argument of a type meeting <a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements"><code class="computeroutput">ConstBufferSequence</code></a>
        requirements. The constant buffer sequence specifies memory where the data
        to be written is located. A write operation shall always write a buffer in
        the sequence completely before proceeding to the next.
      </p>
<p>
        If a read or write operation is also an <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
        operation</a>, the operation shall maintain one or more copies of the
        buffer sequence until such time as the operation no longer requires access
        to the memory specified by the buffers in the sequence. The program shall
        ensure the memory remains valid until:
      </p>
<p>
        &#8212; the last copy of the buffer sequence is destroyed, or
      </p>
<p>
        &#8212; the completion handler for the asynchronous operation is invoked,
      </p>
<p>
        whichever comes first.
      </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 &#169; 2003-2019 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="asynchronous_operations.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="synchronous_socket_operations.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>