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