1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::basic_parser::on_chunk_body_impl</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__basic_parser.html" title="http::basic_parser"> 9<link rel="prev" href="on_chunk_header_impl.html" title="http::basic_parser::on_chunk_header_impl"> 10<link rel="next" href="on_finish_impl.html" title="http::basic_parser::on_finish_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="on_chunk_header_impl.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_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="on_finish_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__basic_parser.on_chunk_body_impl"></a><a class="link" href="on_chunk_body_impl.html" title="http::basic_parser::on_chunk_body_impl">http::basic_parser::on_chunk_body_impl</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057547121792"></a> 31 </p> 32<p> 33 Called each time additional data is received representing part of a body 34 chunk. 35 </p> 36<h6> 37<a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.h0"></a> 38 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.synopsis"></a></span><a class="link" href="on_chunk_body_impl.html#beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.synopsis">Synopsis</a> 39 </h6> 40<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 41<span class="identifier">on_chunk_body_impl</span><span class="special">(</span> 42 <span class="identifier">std</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">remain</span><span class="special">,</span> 43 <span class="identifier">string_view</span> <span class="identifier">body</span><span class="special">,</span> 44 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 45</pre> 46<h6> 47<a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.h1"></a> 48 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.description"></a></span><a class="link" href="on_chunk_body_impl.html#beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.description">Description</a> 49 </h6> 50<p> 51 This virtual function is invoked for each piece of the body which is received 52 while parsing of a message. This function is only used when no chunked 53 transfer encoding is present. 54 </p> 55<h6> 56<a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.h2"></a> 57 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.parameters"></a></span><a class="link" href="on_chunk_body_impl.html#beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.parameters">Parameters</a> 58 </h6> 59<div class="informaltable"><table class="table"> 60<colgroup> 61<col> 62<col> 63</colgroup> 64<thead><tr> 65<th> 66 <p> 67 Name 68 </p> 69 </th> 70<th> 71 <p> 72 Description 73 </p> 74 </th> 75</tr></thead> 76<tbody> 77<tr> 78<td> 79 <p> 80 <code class="computeroutput"><span class="identifier">remain</span></code> 81 </p> 82 </td> 83<td> 84 <p> 85 The number of bytes remaining in this chunk. This includes the 86 contents of passed <code class="computeroutput"><span class="identifier">body</span></code>. 87 If this value is zero, then this represents the final chunk. 88 </p> 89 </td> 90</tr> 91<tr> 92<td> 93 <p> 94 <code class="computeroutput"><span class="identifier">body</span></code> 95 </p> 96 </td> 97<td> 98 <p> 99 A string holding the additional body contents. This may contain 100 nulls or unprintable characters. 101 </p> 102 </td> 103</tr> 104<tr> 105<td> 106 <p> 107 <code class="computeroutput"><span class="identifier">ec</span></code> 108 </p> 109 </td> 110<td> 111 <p> 112 An output parameter which the function may set to indicate an 113 error. The error will be clear before this function is invoked. 114 </p> 115 </td> 116</tr> 117</tbody> 118</table></div> 119<h6> 120<a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.h3"></a> 121 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.return_value"></a></span><a class="link" href="on_chunk_body_impl.html#beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.return_value">Return 122 Value</a> 123 </h6> 124<p> 125 This function should return the number of bytes actually consumed from 126 the <code class="computeroutput"><span class="identifier">body</span></code> value. Any bytes 127 that are not consumed on this call will be presented in a subsequent call. 128 </p> 129<h6> 130<a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.h4"></a> 131 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.see_also"></a></span><a class="link" href="on_chunk_body_impl.html#beast.ref.boost__beast__http__basic_parser.on_chunk_body_impl.see_also">See 132 Also</a> 133 </h6> 134<p> 135 <a class="link" href="on_body_impl.html" title="http::basic_parser::on_body_impl"><code class="computeroutput"><span class="identifier">on_body_impl</span></code></a> 136 </p> 137</div> 138<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 139<td align="left"></td> 140<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 141 Falco<p> 142 Distributed under the Boost Software License, Version 1.0. (See accompanying 143 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>) 144 </p> 145</div></td> 146</tr></table> 147<hr> 148<div class="spirit-nav"> 149<a accesskey="p" href="on_chunk_header_impl.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_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="on_finish_impl.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 150</div> 151</body> 152</html> 153
