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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>basic_stream_socket::async_receive (2 of 2 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="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../async_receive.html" title="basic_stream_socket::async_receive">
<link rel="prev" href="overload1.html" title="basic_stream_socket::async_receive (1 of 2 overloads)">
<link rel="next" href="../async_send.html" title="basic_stream_socket::async_send">
</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/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_receive.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../async_send.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" title="basic_stream_socket::async_receive (2 of 2 overloads)">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.basic_stream_socket.async_receive.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::async_receive (2 of 2 overloads)">
basic_stream_socket::async_receive (2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Start an asynchronous receive.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
<span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="../../ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">></span>
<span class="keyword">void</span> <span class="identifier">async_receive</span><span class="special">(</span>
<span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span>
<span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">message_flags</span> <span class="identifier">flags</span><span class="special">,</span>
<span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
<p>
This function is used to asynchronously receive data from the stream
socket. The function call always returns immediately.
</p>
<a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.parameters"></a><h6>
<a name="id859924"></a>
<a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.async_receive.overload2.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. Although
the buffers object may be copied as necessary, ownership of the underlying
memory blocks is retained by the caller, which must guarantee that
they remain valid until the handler is called.
</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">handler</span></dt>
<dd>
<p>
The handler to be called when the receive operation completes. Copies
will be made of the handler as required. The function signature of
the handler must be:
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
<span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.
</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// Number of bytes received.
</span><span class="special">);</span>
</pre>
<p>
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
Invocation of the handler will be performed in a manner equivalent
to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>.
</p>
</dd>
</dl>
</div>
<a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.remarks"></a><h6>
<a name="id860146"></a>
<a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.async_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="../../async_read.html" title="async_read"><code class="computeroutput"><span class="identifier">async_read</span></code></a> function if you need
to ensure that the requested amount of data is received before the asynchronous
operation completes.
</p>
<a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.example"></a><h6>
<a name="id860192"></a>
<a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.async_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"><span class="identifier">buffer</span></code></a> function as follows:
</p>
<pre class="programlisting"><span class="identifier">socket</span><span class="special">.</span><span class="identifier">async_receive</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
<p>
See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></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 - 2010 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/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_receive.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../async_send.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
