1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_seq_packet_socket::receive (2 of 3 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="../receive.html" title="basic_seq_packet_socket::receive"> 9<link rel="prev" href="overload1.html" title="basic_seq_packet_socket::receive (1 of 3 overloads)"> 10<link rel="next" href="overload3.html" title="basic_seq_packet_socket::receive (3 of 3 overloads)"> 11</head> 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> 20</tr></table> 21<hr> 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="../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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2"></a><a class="link" href="overload2.html" title="basic_seq_packet_socket::receive (2 of 3 overloads)">basic_seq_packet_socket::receive 28 (2 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 Receive some data on the socket. 32 </p> 33<pre class="programlisting">template< 34 typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> 35std::size_t receive( 36 const MutableBufferSequence & buffers, 37 socket_base::message_flags in_flags, 38 socket_base::message_flags & out_flags); 39</pre> 40<p> 41 This function is used to receive data on the sequenced packet socket. 42 The function call will block until data has been received successfully, 43 or until an error occurs. 44 </p> 45<h6> 46<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h0"></a> 47 <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.parameters">Parameters</a> 48 </h6> 49<div class="variablelist"> 50<p class="title"><b></b></p> 51<dl class="variablelist"> 52<dt><span class="term">buffers</span></dt> 53<dd><p> 54 One or more buffers into which the data will be received. 55 </p></dd> 56<dt><span class="term">in_flags</span></dt> 57<dd><p> 58 Flags specifying how the receive call is to be made. 59 </p></dd> 60<dt><span class="term">out_flags</span></dt> 61<dd><p> 62 After the receive call completes, contains flags associated with 63 the received data. For example, if the <code class="computeroutput">socket_base::message_end_of_record</code> 64 bit is set then the received data marks the end of a record. 65 </p></dd> 66</dl> 67</div> 68<h6> 69<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h1"></a> 70 <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.return_value">Return 71 Value</a> 72 </h6> 73<p> 74 The number of bytes received. 75 </p> 76<h6> 77<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h2"></a> 78 <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.exceptions">Exceptions</a> 79 </h6> 80<div class="variablelist"> 81<p class="title"><b></b></p> 82<dl class="variablelist"> 83<dt><span class="term">boost::system::system_error</span></dt> 84<dd><p> 85 Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code> 86 indicates that the connection was closed by the peer. 87 </p></dd> 88</dl> 89</div> 90<h6> 91<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h3"></a> 92 <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.remarks">Remarks</a> 93 </h6> 94<p> 95 The receive operation may not receive all of the requested number of 96 bytes. Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a> 97 function if you need to ensure that the requested amount of data is read 98 before the blocking operation completes. 99 </p> 100<h6> 101<a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.h4"></a> 102 <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_seq_packet_socket.receive.overload2.example">Example</a> 103 </h6> 104<p> 105 To receive into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> 106 function as follows: 107 </p> 108<pre class="programlisting">socket.receive(boost::asio::buffer(data, size), 0, out_flags); 109</pre> 110<p> 111 See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> 112 documentation for information on receiving into multiple buffers in one 113 go, and how to use it with arrays, boost::array or std::vector. 114 </p> 115</div> 116<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 117<td align="left"></td> 118<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 119 Kohlhoff<p> 120 Distributed under the Boost Software License, Version 1.0. (See accompanying 121 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>) 122 </p> 123</div></td> 124</tr></table> 125<hr> 126<div class="spirit-nav"> 127<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 128</div> 129</body> 130</html> 131
