1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_raw_socket::receive_from (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_from.html" title="basic_raw_socket::receive_from"> 9<link rel="prev" href="../receive_from.html" title="basic_raw_socket::receive_from"> 10<link rel="next" href="overload2.html" title="basic_raw_socket::receive_from (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_from.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive_from.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_from.overload1"></a><a class="link" href="overload1.html" title="basic_raw_socket::receive_from (1 of 3 overloads)">basic_raw_socket::receive_from 28 (1 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 Receive raw data with the endpoint of the sender. 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_from( 36 const MutableBufferSequence & buffers, 37 endpoint_type & sender_endpoint); 38</pre> 39<p> 40 This function is used to receive raw data. The function call will block 41 until data has been received successfully or an error occurs. 42 </p> 43<h6> 44<a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.h0"></a> 45 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive_from.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<dt><span class="term">sender_endpoint</span></dt> 55<dd><p> 56 An endpoint object that receives the endpoint of the remote sender 57 of the data. 58 </p></dd> 59</dl> 60</div> 61<h6> 62<a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.h1"></a> 63 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive_from.overload1.return_value">Return 64 Value</a> 65 </h6> 66<p> 67 The number of bytes received. 68 </p> 69<h6> 70<a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.h2"></a> 71 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive_from.overload1.exceptions">Exceptions</a> 72 </h6> 73<div class="variablelist"> 74<p class="title"><b></b></p> 75<dl class="variablelist"> 76<dt><span class="term">boost::system::system_error</span></dt> 77<dd><p> 78 Thrown on failure. 79 </p></dd> 80</dl> 81</div> 82<h6> 83<a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.h3"></a> 84 <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.receive_from.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.receive_from.overload1.example">Example</a> 85 </h6> 86<p> 87 To receive into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> 88 function as follows: 89 </p> 90<pre class="programlisting">boost::asio::ip::udp::endpoint sender_endpoint; 91socket.receive_from( 92 boost::asio::buffer(data, size), sender_endpoint); 93</pre> 94<p> 95 See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> 96 documentation for information on receiving into multiple buffers in one 97 go, and how to use it with arrays, boost::array or std::vector. 98 </p> 99</div> 100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 101<td align="left"></td> 102<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 103 Kohlhoff<p> 104 Distributed under the Boost Software License, Version 1.0. (See accompanying 105 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>) 106 </p> 107</div></td> 108</tr></table> 109<hr> 110<div class="spirit-nav"> 111<a accesskey="p" href="../receive_from.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../receive_from.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> 112</div> 113</body> 114</html> 115
