diff options
Diffstat (limited to 'doc/html/boost_asio/reference/basic_stream_socket/receive/overload1.html')
| -rw-r--r-- | doc/html/boost_asio/reference/basic_stream_socket/receive/overload1.html | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/html/boost_asio/reference/basic_stream_socket/receive/overload1.html b/doc/html/boost_asio/reference/basic_stream_socket/receive/overload1.html index efbce41f83..c3c39c0818 100644 --- a/doc/html/boost_asio/reference/basic_stream_socket/receive/overload1.html +++ b/doc/html/boost_asio/reference/basic_stream_socket/receive/overload1.html @@ -30,10 +30,10 @@ <p> Receive some data on the socket. </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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">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> +<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); </pre> <p> This function is used to receive data on the stream socket. The function @@ -70,7 +70,7 @@ <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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code> + 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> @@ -81,21 +81,22 @@ </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"><span class="identifier">read</span></code></a> function if you need to - ensure that the requested amount of data is read before the blocking - operation completes. + 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_stream_socket.receive.overload1.h4"></a> <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.receive.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.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: + 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"><span class="identifier">socket</span><span class="special">.</span><span class="identifier">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> +<pre class="programlisting">socket.receive(boost::asio::buffer(data, size)); </pre> <p> - See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> + 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> |