3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>basic_stream_socket::async_receive (2 of 2 overloads)</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../async_receive.html" title="basic_stream_socket::async_receive">
9 <link rel="prev" href="overload1.html" title="basic_stream_socket::async_receive (1 of 2 overloads)">
10 <link rel="next" href="../async_send.html" title="basic_stream_socket::async_send">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_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="../async_send.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <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
28 (2 of 2 overloads)</a>
29 </h5></div></div></div>
31 Start an asynchronous receive.
33 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
34 <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
35 <span class="keyword">typename</span> <a class="link" href="../../ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">></span>
36 <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_receive</span><span class="special">(</span>
37 <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span>
38 <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>
39 <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span>
42 This function is used to asynchronously receive data from the stream
43 socket. The function call always returns immediately.
46 <a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.h0"></a>
47 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.async_receive.overload2.parameters">Parameters</a>
49 <div class="variablelist">
50 <p class="title"><b></b></p>
51 <dl class="variablelist">
52 <dt><span class="term">buffers</span></dt>
54 One or more buffers into which the data will be received. Although
55 the buffers object may be copied as necessary, ownership of the
56 underlying memory blocks is retained by the caller, which must
57 guarantee that they remain valid until the handler is called.
59 <dt><span class="term">flags</span></dt>
61 Flags specifying how the receive call is to be made.
63 <dt><span class="term">handler</span></dt>
66 The handler to be called when the receive operation completes.
67 Copies will be made of the handler as required. The function signature
68 of the handler must be:
70 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
71 <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>
72 <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>
73 <span class="special">);</span>
76 Regardless of whether the asynchronous operation completes immediately
77 or not, the handler will not be invoked from within this function.
78 Invocation of the handler will be performed in a manner equivalent
79 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>.
85 <a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.h1"></a>
86 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.async_receive.overload2.remarks">Remarks</a>
89 The receive operation may not receive all of the requested number of
90 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
91 to ensure that the requested amount of data is received before the asynchronous
95 <a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.h2"></a>
96 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_receive.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.async_receive.overload2.example">Example</a>
99 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:
101 <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>
104 See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
105 documentation for information on receiving into multiple buffers in one
106 go, and how to use it with arrays, boost::array or std::vector.
109 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
110 <td align="left"></td>
111 <td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p>
112 Distributed under the Boost Software License, Version 1.0. (See accompanying
113 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>)
118 <div class="spirit-nav">
119 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_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="../async_send.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>