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