blob: 8c806ecc9ec6696d821f27bd4ddc75f73cb1133e (
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
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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>basic_seq_packet_socket::receive (2 of 3 overloads)</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="../receive.html" title="basic_seq_packet_socket::receive">
<link rel="prev" href="overload1.html" title="basic_seq_packet_socket::receive (1 of 3 overloads)">
<link rel="next" href="overload3.html" title="basic_seq_packet_socket::receive (3 of 3 overloads)">
</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2"></a><a class="link" href="overload2.html" title="basic_seq_packet_socket::receive (2 of 3 overloads)">basic_seq_packet_socket::receive
(2 of 3 overloads)</a>
</h5></div></div></div>
<p>
Receive some data on the socket.
</p>
<pre class="programlisting">template<
typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>>
std::size_t receive(
const MutableBufferSequence & buffers,
socket_base::message_flags in_flags,
socket_base::message_flags & out_flags);
</pre>
<p>
This function is used to receive data on the sequenced packet socket.
The function call will block until data has been received successfully,
or until an error occurs.
</p>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h0"></a>
<span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">buffers</span></dt>
<dd><p>
One or more buffers into which the data will be received.
</p></dd>
<dt><span class="term">in_flags</span></dt>
<dd><p>
Flags specifying how the receive call is to be made.
</p></dd>
<dt><span class="term">out_flags</span></dt>
<dd><p>
After the receive call completes, contains flags associated with
the received data. For example, if the <code class="computeroutput">socket_base::message_end_of_record</code>
bit is set then the received data marks the end of a record.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h1"></a>
<span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes received.
</p>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h2"></a>
<span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code>
indicates that the connection was closed by the peer.
</p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h3"></a>
<span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.remarks">Remarks</a>
</h6>
<p>
The receive operation may not receive all of the requested number of
bytes. Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a>
function if you need to ensure that the requested amount of data is read
before the blocking operation completes.
</p>
<h6>
<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h4"></a>
<span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.example">Example</a>
</h6>
<p>
To receive into 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">socket.receive(boost::asio::buffer(data, size), 0, out_flags);
</pre>
<p>
See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
documentation for information on receiving into multiple buffers in one
go, and how to use it with arrays, boost::array or std::vector.
</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-2017 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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
