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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::basic_parser::body_limit</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="basic_parser0.html" title="http::basic_parser::basic_parser">
  10 <link rel="next" href="chunked.html" title="http::basic_parser::chunked">
  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="basic_parser0.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="chunked.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.body_limit"></a><a class="link" href="body_limit.html" title="http::basic_parser::body_limit">http::basic_parser::body_limit</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873502947680"></a>
  31 Set the limit on the payload body.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__basic_parser.body_limit.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.body_limit.synopsis"></a></span><a class="link" href="body_limit.html#beast.ref.boost__beast__http__basic_parser.body_limit.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">body_limit</span><span class="special">(</span>
  39     <span class="identifier">std</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">v</span><span class="special">);</span>
  40 </pre>
  41 <h6>
  42 <a name="beast.ref.boost__beast__http__basic_parser.body_limit.h1"></a>
  43           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.body_limit.description"></a></span><a class="link" href="body_limit.html#beast.ref.boost__beast__http__basic_parser.body_limit.description">Description</a>
  44         </h6>
  45 <p>
  46           This function sets the maximum allowed size of the payload body, before
  47           any encodings except chunked have been removed. Depending on the message
  48           semantics, one of these cases will apply:
  49         </p>
  50 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  51 <li class="listitem">
  52               The Content-Length is specified and exceeds the limit. In this case
  53               the result <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">body_limit</span></code></a> is returned immediately
  54               after the header is parsed.
  55             </li>
  56 <li class="listitem">
  57               The Content-Length is unspecified and the chunked encoding is not specified
  58               as the last encoding. In this case the end of message is determined
  59               by the end of file indicator on the associated stream or input source.
  60               If a sufficient number of body payload octets are presented to the
  61               parser to exceed the configured limit, the parse fails with the result
  62               <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">body_limit</span></code></a>
  63             </li>
  64 <li class="listitem">
  65               The Transfer-Encoding specifies the chunked encoding as the last encoding.
  66               In this case, when the number of payload body octets produced by removing
  67               the chunked encoding exceeds the configured limit, the parse fails
  68               with the result <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">body_limit</span></code></a>.
  69             </li>
  70 </ul></div>
  71 <p>
  72           Setting the limit after any body octets have been parsed results in undefined
  73           behavior. The default limit is 1MB for requests and 8MB for responses.
  74         </p>
  75 <h6>
  76 <a name="beast.ref.boost__beast__http__basic_parser.body_limit.h2"></a>
  77           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.body_limit.parameters"></a></span><a class="link" href="body_limit.html#beast.ref.boost__beast__http__basic_parser.body_limit.parameters">Parameters</a>
  78         </h6>
  79 <div class="informaltable"><table class="table">
  80 <colgroup>
  81 <col>
  82 <col>
  83 </colgroup>
  84 <thead><tr>
  85 <th>
  86                   <p>
  87                     Name
  88                   </p>
  89                 </th>
  90 <th>
  91                   <p>
  92                     Description
  93                   </p>
  94                 </th>
  95 </tr></thead>
  96 <tbody><tr>
  97 <td>
  98                   <p>
  99                     <code class="computeroutput"><span class="identifier">v</span></code>
 100                   </p>
 101                 </td>
 102 <td>
 103                   <p>
 104                     The payload body limit to set
 105                   </p>
 106                 </td>
 107 </tr></tbody>
 108 </table></div>
 109 </div>
 110 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 111 <td align="left"></td>
 112 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 113       Falco<p>
 114         Distributed under the Boost Software License, Version 1.0. (See accompanying
 115         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>)
 116       </p>
 117 </div></td>
 118 </tr></table>
 119 <hr>
 120 <div class="spirit-nav">
 121 <a accesskey="p" href="basic_parser0.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="chunked.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 122 </div>
 123 </body>
 124 </html>