1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::parser::on_chunk_body</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__parser.html" title="http::parser"> 9<link rel="prev" href="on_chunk_header.html" title="http::parser::on_chunk_header"> 10<link rel="next" href="got_some.html" title="http::parser::got_some"> 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="on_chunk_header.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__parser.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="got_some.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__parser.on_chunk_body"></a><a class="link" href="on_chunk_body.html" title="http::parser::on_chunk_body">http::parser::on_chunk_body</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057530663264"></a> 31 </p> 32<p> 33 Set a callback to be invoked on chunk body data. 34 </p> 35<h6> 36<a name="beast.ref.boost__beast__http__parser.on_chunk_body.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__http__parser.on_chunk_body.synopsis"></a></span><a class="link" href="on_chunk_body.html#beast.ref.boost__beast__http__parser.on_chunk_body.synopsis">Synopsis</a> 38 </h6> 39<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 40 <span class="keyword">class</span> <span class="identifier">Callback</span><span class="special">></span> 41<span class="keyword">void</span> 42<span class="identifier">on_chunk_body</span><span class="special">(</span> 43 <span class="identifier">Callback</span><span class="special">&</span> <span class="identifier">cb</span><span class="special">);</span> 44</pre> 45<h6> 46<a name="beast.ref.boost__beast__http__parser.on_chunk_body.h1"></a> 47 <span class="phrase"><a name="beast.ref.boost__beast__http__parser.on_chunk_body.description"></a></span><a class="link" href="on_chunk_body.html#beast.ref.boost__beast__http__parser.on_chunk_body.description">Description</a> 48 </h6> 49<p> 50 The provided function object will be invoked one or more times to provide 51 buffers corresponding to the chunk body for the current chunk. The callback 52 receives the number of octets remaining in this chunk body including the 53 octets in the buffer provided. The callback must return the number of octets 54 actually consumed. Any octets not consumed will be presented again in a 55 subsequent invocation of the callback. The implementation type-erases the 56 callback without requiring a dynamic allocation. For this reason, the callback 57 object is passed by a non-constant reference. 58 </p> 59<h6> 60<a name="beast.ref.boost__beast__http__parser.on_chunk_body.h2"></a> 61 <span class="phrase"><a name="beast.ref.boost__beast__http__parser.on_chunk_body.example"></a></span><a class="link" href="on_chunk_body.html#beast.ref.boost__beast__http__parser.on_chunk_body.example">Example</a> 62 </h6> 63<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">callback</span> <span class="special">=</span> 64 <span class="special">[](</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">remain</span><span class="special">,</span> <span class="identifier">string_view</span> <span class="identifier">body</span><span class="special">,</span> <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">)</span> 65 <span class="special">{</span> 66 <span class="comment">//...</span> 67 <span class="special">};</span> 68<span class="identifier">parser</span><span class="special">.</span><span class="identifier">on_chunk_body</span><span class="special">(</span><span class="identifier">callback</span><span class="special">);</span> 69</pre> 70<h6> 71<a name="beast.ref.boost__beast__http__parser.on_chunk_body.h3"></a> 72 <span class="phrase"><a name="beast.ref.boost__beast__http__parser.on_chunk_body.parameters"></a></span><a class="link" href="on_chunk_body.html#beast.ref.boost__beast__http__parser.on_chunk_body.parameters">Parameters</a> 73 </h6> 74<div class="informaltable"><table class="table"> 75<colgroup> 76<col> 77<col> 78</colgroup> 79<thead><tr> 80<th> 81 <p> 82 Name 83 </p> 84 </th> 85<th> 86 <p> 87 Description 88 </p> 89 </th> 90</tr></thead> 91<tbody><tr> 92<td> 93 <p> 94 <code class="computeroutput"><span class="identifier">cb</span></code> 95 </p> 96 </td> 97<td> 98 <p> 99 The function to set, which must be invocable with this equivalent 100 signature: 101 </p> 102<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 103<span class="identifier">on_chunk_header</span><span class="special">(</span> 104 <span class="identifier">std</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">remain</span><span class="special">,</span> <span class="comment">// Octets remaining in this chunk, includes `body`</span> 105 <span class="identifier">string_view</span> <span class="identifier">body</span><span class="special">,</span> <span class="comment">// A buffer holding some or all of the remainder of the chunk body</span> 106 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> <span class="comment">// May be set by the callback to indicate an error</span> 107</pre> 108 </td> 109</tr></tbody> 110</table></div> 111</div> 112<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 113<td align="left"></td> 114<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 115 Falco<p> 116 Distributed under the Boost Software License, Version 1.0. (See accompanying 117 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>) 118 </p> 119</div></td> 120</tr></table> 121<hr> 122<div class="spirit-nav"> 123<a accesskey="p" href="on_chunk_header.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__parser.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="got_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 124</div> 125</body> 126</html> 127
