libs/beast/doc/html/beast/ref/boost__beast__http__basic_parser/on_chunk_body_impl.html

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