overload3.html
4.93 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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream_socket::receive (3 of 3 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="../receive.html" title="basic_stream_socket::receive">
<link rel="prev" href="overload2.html" title="basic_stream_socket::receive (2 of 3 overloads)">
<link rel="next" href="../receive_buffer_size.html" title="basic_stream_socket::receive_buffer_size">
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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="../receive_buffer_size.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_stream_socket.receive.overload3"></a><a class="link" href="overload3.html" title="basic_stream_socket::receive (3 of 3 overloads)">basic_stream_socket::receive
(3 of 3 overloads)</a>
</h5></div></div></div>
<p>
Receive some data on a connected 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 flags,
asio::error_code & ec);
</pre>
<p>
This function is used to receive data on the stream socket. The function
call will block until one or more bytes of data has been received successfully,
or until an error occurs.
</p>
<h6>
<a name="asio.reference.basic_stream_socket.receive.overload3.h0"></a>
<span><a name="asio.reference.basic_stream_socket.receive.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_stream_socket.receive.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<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">flags</span></dt>
<dd><p>
Flags specifying how the receive call is to be made.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_stream_socket.receive.overload3.h1"></a>
<span><a name="asio.reference.basic_stream_socket.receive.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.basic_stream_socket.receive.overload3.return_value">Return
Value</a>
</h6>
<p>
The number of bytes received. Returns 0 if an error occurred.
</p>
<h6>
<a name="asio.reference.basic_stream_socket.receive.overload3.h2"></a>
<span><a name="asio.reference.basic_stream_socket.receive.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.basic_stream_socket.receive.overload3.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>
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../receive.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="../receive_buffer_size.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>