doc/html/boost_asio/reference/basic_seq_packet_socket/receive/overload3.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_seq_packet_socket::receive (3 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.78.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="overload2.html" title="basic_seq_packet_socket::receive (2 of 3 overloads)">
  10 <link rel="next" href="../receive_buffer_size.html" title="basic_seq_packet_socket::receive_buffer_size">
  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="overload2.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="../receive_buffer_size.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.overload3"></a><a class="link" href="overload3.html" title="basic_seq_packet_socket::receive (3 of 3 overloads)">basic_seq_packet_socket::receive
  28           (3 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"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  35 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">receive</span><span class="special">(</span>
  36     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  37     <span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">message_flags</span> <span class="identifier">in_flags</span><span class="special">,</span>
  38     <span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">message_flags</span> <span class="special">&amp;</span> <span class="identifier">out_flags</span><span class="special">,</span>
  39     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  40 </pre>
  41 <p>
  42             This function is used to receive data on the sequenced packet socket.
  43             The function call will block until data has been received successfully,
  44             or until an error occurs.
  45           </p>
  46 <h6>
  47 <a name="boost_asio.reference.basic_seq_packet_socket.receive.overload3.h0"></a>
  48             <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_seq_packet_socket.receive.overload3.parameters">Parameters</a>
  49           </h6>
  50 <div class="variablelist">
  51 <p class="title"><b></b></p>
  52 <dl class="variablelist">
  53 <dt><span class="term">buffers</span></dt>
  54 <dd><p>
  55                   One or more buffers into which the data will be received.
  56                 </p></dd>
  57 <dt><span class="term">in_flags</span></dt>
  58 <dd><p>
  59                   Flags specifying how the receive call is to be made.
  60                 </p></dd>
  61 <dt><span class="term">out_flags</span></dt>
  62 <dd><p>
  63                   After the receive call completes, contains flags associated with
  64                   the received data. For example, if the <code class="computeroutput"><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">message_end_of_record</span></code>
  65                   bit is set then the received data marks the end of a record.
  66                 </p></dd>
  67 <dt><span class="term">ec</span></dt>
  68 <dd><p>
  69                   Set to indicate what error occurred, if any.
  70                 </p></dd>
  71 </dl>
  72 </div>
  73 <h6>
  74 <a name="boost_asio.reference.basic_seq_packet_socket.receive.overload3.h1"></a>
  75             <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_seq_packet_socket.receive.overload3.return_value">Return
  76             Value</a>
  77           </h6>
  78 <p>
  79             The number of bytes received. Returns 0 if an error occurred.
  80           </p>
  81 <h6>
  82 <a name="boost_asio.reference.basic_seq_packet_socket.receive.overload3.h2"></a>
  83             <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.receive.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_seq_packet_socket.receive.overload3.remarks">Remarks</a>
  84           </h6>
  85 <p>
  86             The receive operation may not receive all of the requested number of
  87             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
  88             ensure that the requested amount of data is read before the blocking
  89             operation completes.
  90           </p>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         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>)
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="overload2.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="../receive_buffer_size.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>