libs/beast/doc/html/beast/ref/boost__beast__http__serializer/consume.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::serializer::consume</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="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__http__serializer.html" title="http::serializer">
   9 <link rel="prev" href="../boost__beast__http__serializer.html" title="http::serializer">
  10 <link rel="next" href="get.html" title="http::serializer::get">
  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="../boost__beast__http__serializer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__serializer.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get.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="beast.ref.boost__beast__http__serializer.consume"></a><a class="link" href="consume.html" title="http::serializer::consume">http::serializer::consume</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873490787264"></a>
  31 Consume buffer octets in the serialization.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__serializer.consume.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__serializer.consume.synopsis"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__http__serializer.consume.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">consume</span><span class="special">(</span>
  39     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span><span class="special">);</span>
  40 </pre>
  41 <h6>
  42 <a name="beast.ref.boost__beast__http__serializer.consume.h1"></a>
  43           <span class="phrase"><a name="beast.ref.boost__beast__http__serializer.consume.description"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__http__serializer.consume.description">Description</a>
  44         </h6>
  45 <p>
  46           This function should be called after one or more octets contained in the
  47           buffers provided in the prior call to <a class="link" href="next.html" title="http::serializer::next"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">next</span></code></a> have been used. After a call
  48           to <a class="link" href="consume.html" title="http::serializer::consume"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">consume</span></code></a>, callers should check
  49           the return value of <a class="link" href="is_done.html" title="http::serializer::is_done"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">is_done</span></code></a> to determine if the entire
  50           message has been serialized.
  51         </p>
  52 <h6>
  53 <a name="beast.ref.boost__beast__http__serializer.consume.h2"></a>
  54           <span class="phrase"><a name="beast.ref.boost__beast__http__serializer.consume.parameters"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__http__serializer.consume.parameters">Parameters</a>
  55         </h6>
  56 <div class="informaltable"><table class="table">
  57 <colgroup>
  58 <col>
  59 <col>
  60 </colgroup>
  61 <thead><tr>
  62 <th>
  63                   <p>
  64                     Name
  65                   </p>
  66                 </th>
  67 <th>
  68                   <p>
  69                     Description
  70                   </p>
  71                 </th>
  72 </tr></thead>
  73 <tbody><tr>
  74 <td>
  75                   <p>
  76                     <code class="computeroutput"><span class="identifier">n</span></code>
  77                   </p>
  78                 </td>
  79 <td>
  80                   <p>
  81                     The number of octets to consume. This number must be greater
  82                     than zero and no greater than the number of octets in the buffers
  83                     provided in the prior call to <a class="link" href="next.html" title="http::serializer::next"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">next</span></code></a>.
  84                   </p>
  85                 </td>
  86 </tr></tbody>
  87 </table></div>
  88 </div>
  89 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  90 <td align="left"></td>
  91 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  92       Falco<p>
  93         Distributed under the Boost Software License, Version 1.0. (See accompanying
  94         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>)
  95       </p>
  96 </div></td>
  97 </tr></table>
  98 <hr>
  99 <div class="spirit-nav">
 100 <a accesskey="p" href="../boost__beast__http__serializer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__serializer.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 101 </div>
 102 </body>
 103 </html>