diff options
Diffstat (limited to 'doc/html/boost_asio/reference/basic_seq_packet_socket/async_receive/overload1.html')
| -rwxr-xr-x | doc/html/boost_asio/reference/basic_seq_packet_socket/async_receive/overload1.html | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/basic_seq_packet_socket/async_receive/overload1.html b/doc/html/boost_asio/reference/basic_seq_packet_socket/async_receive/overload1.html new file mode 100755 index 0000000000..7349faeb10 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_seq_packet_socket/async_receive/overload1.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_seq_packet_socket::async_receive (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../async_receive.html" title="basic_seq_packet_socket::async_receive"> +<link rel="prev" href="../async_receive.html" title="basic_seq_packet_socket::async_receive"> +<link rel="next" href="overload2.html" title="basic_seq_packet_socket::async_receive (2 of 2 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="../async_receive.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="overload2.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.async_receive.overload1"></a><a class="link" href="overload1.html" title="basic_seq_packet_socket::async_receive (1 of 2 overloads)">basic_seq_packet_socket::async_receive + (1 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="special">&</span> <span class="identifier">out_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 sequenced + packet socket. The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.basic_seq_packet_socket.async_receive.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_seq_packet_socket.async_receive.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.async_receive.overload1.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">out_flags</span></dt> +<dd><p> + Once the asynchronous operation completes, contains flags associated + with the received data. For example, if the <code class="computeroutput"><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">message_end_of_record</span></code> + bit is set then the received data marks the end of a record. The + caller must guarantee that the referenced variable remains valid + until the handler is called. + </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> +<h6> +<a name="boost_asio.reference.basic_seq_packet_socket.async_receive.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_seq_packet_socket.async_receive.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.async_receive.overload1.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="identifier">out_flags</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-2012 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="../async_receive.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |