1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_raw_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_raw_socket::receive"> 9<link rel="prev" href="../receive.html" title="basic_raw_socket::receive"> 10<link rel="next" href="overload2.html" title="basic_raw_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_raw_socket.receive.overload1"></a><a class="link" href="overload1.html" title="basic_raw_socket::receive (1 of 3 overloads)">basic_raw_socket::receive 28 (1 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 Receive some data on a connected 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</pre> 38<p> 39 This function is used to receive data on the raw socket. The function 40 call will block until data has been received successfully or an error 41 occurs. 42 </p> 43<h6> 44<a name="boost_asio.reference.basic_raw_socket.receive.overload1.h0"></a> 45 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive.overload1.parameters">Parameters</a> 46 </h6> 47<div class="variablelist"> 48<p class="title"><b></b></p> 49<dl class="variablelist"> 50<dt><span class="term">buffers</span></dt> 51<dd><p> 52 One or more buffers into which the data will be received. 53 </p></dd> 54</dl> 55</div> 56<h6> 57<a name="boost_asio.reference.basic_raw_socket.receive.overload1.h1"></a> 58 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive.overload1.return_value">Return 59 Value</a> 60 </h6> 61<p> 62 The number of bytes received. 63 </p> 64<h6> 65<a name="boost_asio.reference.basic_raw_socket.receive.overload1.h2"></a> 66 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive.overload1.exceptions">Exceptions</a> 67 </h6> 68<div class="variablelist"> 69<p class="title"><b></b></p> 70<dl class="variablelist"> 71<dt><span class="term">boost::system::system_error</span></dt> 72<dd><p> 73 Thrown on failure. 74 </p></dd> 75</dl> 76</div> 77<h6> 78<a name="boost_asio.reference.basic_raw_socket.receive.overload1.h3"></a> 79 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive.overload1.remarks">Remarks</a> 80 </h6> 81<p> 82 The receive operation can only be used with a connected socket. Use the 83 receive_from function to receive data on an unconnected raw socket. 84 </p> 85<h6> 86<a name="boost_asio.reference.basic_raw_socket.receive.overload1.h4"></a> 87 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_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)); 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
