doc/html/boost_asio/reference/transfer_at_least.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>transfer_at_least</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="../reference.html" title="Reference">
   9 <link rel="prev" href="transfer_all.html" title="transfer_all">
  10 <link rel="next" href="transfer_exactly.html" title="transfer_exactly">
  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="transfer_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="transfer_exactly.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.transfer_at_least"></a><a class="link" href="transfer_at_least.html" title="transfer_at_least">transfer_at_least</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp173472304"></a>
  31 Return a completion condition function object that indicates
  32         that a read or write operation should continue until a minimum number of
  33         bytes has been transferred, or until an error occurs.
  34       </p>
  35 <pre class="programlisting"><span class="identifier">unspecified</span> <span class="identifier">transfer_at_least</span><span class="special">(</span>
  36     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">minimum</span><span class="special">);</span>
  37 </pre>
  38 <p>
  39         This function is used to create an object, of unspecified type, that meets
  40         CompletionCondition requirements.
  41       </p>
  42 <h5>
  43 <a name="boost_asio.reference.transfer_at_least.h0"></a>
  44         <span class="phrase"><a name="boost_asio.reference.transfer_at_least.example"></a></span><a class="link" href="transfer_at_least.html#boost_asio.reference.transfer_at_least.example">Example</a>
  45       </h5>
  46 <p>
  47         Reading until a buffer is full or contains at least 64 bytes:
  48       </p>
  49 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">,</span> <span class="number">128</span><span class="special">&gt;</span> <span class="identifier">buf</span><span class="special">;</span>
  50 <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="identifier">ec</span><span class="special">;</span>
  51 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">read</span><span class="special">(</span>
  52     <span class="identifier">sock</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">buf</span><span class="special">),</span>
  53     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">transfer_at_least</span><span class="special">(</span><span class="number">64</span><span class="special">),</span> <span class="identifier">ec</span><span class="special">);</span>
  54 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span>
  55 <span class="special">{</span>
  56   <span class="comment">// An error occurred.</span>
  57 <span class="special">}</span>
  58 <span class="keyword">else</span>
  59 <span class="special">{</span>
  60   <span class="comment">// n &gt;= 64 &amp;&amp; n &lt;= 128</span>
  61 <span class="special">}</span>
  62 </pre>
  63 <h5>
  64 <a name="boost_asio.reference.transfer_at_least.h1"></a>
  65         <span class="phrase"><a name="boost_asio.reference.transfer_at_least.requirements"></a></span><a class="link" href="transfer_at_least.html#boost_asio.reference.transfer_at_least.requirements">Requirements</a>
  66       </h5>
  67 <p>
  68         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/completion_condition.hpp</code>
  69       </p>
  70 <p>
  71         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
  72       </p>
  73 </div>
  74 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  75 <td align="left"></td>
  76 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  77         Distributed under the Boost Software License, Version 1.0. (See accompanying
  78         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>)
  79       </p>
  80 </div></td>
  81 </tr></table>
  82 <hr>
  83 <div class="spirit-nav">
  84 <a accesskey="p" href="transfer_all.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="transfer_exactly.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  85 </div>
  86 </body>
  87 </html>