libs/beast/doc/html/beast/ref/boost__beast__http__parser/header_limit.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::parser::header_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__parser.html" title="http::parser">
   9 <link rel="prev" href="got_some.html" title="http::parser::got_some">
  10 <link rel="next" href="is_done.html" title="http::parser::is_done">
  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="got_some.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="is_done.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.header_limit"></a><a class="link" href="header_limit.html" title="http::parser::header_limit">http::parser::header_limit</a>
  28 </h5></div></div></div>
  29 <p>
  30           (Inherited from <code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">basic_parser</span></code>)
  31         </p>
  32 <p>
  33           <a class="indexterm" name="idm45873493658192"></a>
  34 Set a limit on the total size of the header.
  35         </p>
  36 <h6>
  37 <a name="beast.ref.boost__beast__http__parser.header_limit.h0"></a>
  38           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.header_limit.synopsis"></a></span><a class="link" href="header_limit.html#beast.ref.boost__beast__http__parser.header_limit.synopsis">Synopsis</a>
  39         </h6>
  40 <pre class="programlisting"><span class="keyword">void</span>
  41 <span class="identifier">header_limit</span><span class="special">(</span>
  42     <span class="identifier">std</span><span class="special">::</span><span class="identifier">uint32_t</span> <span class="identifier">v</span><span class="special">);</span>
  43 </pre>
  44 <h6>
  45 <a name="beast.ref.boost__beast__http__parser.header_limit.h1"></a>
  46           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.header_limit.description"></a></span><a class="link" href="header_limit.html#beast.ref.boost__beast__http__parser.header_limit.description">Description</a>
  47         </h6>
  48 <p>
  49           This function sets the maximum allowed size of the header including all
  50           field name, value, and delimiter characters and also including the CRLF
  51           sequences in the serialized input. If the end of the header is not found
  52           within the limit of the header size, the error <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">header_limit</span></code></a> is returned by <a class="link" href="../boost__beast__http__basic_parser/put.html" title="http::basic_parser::put"><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">put</span></code></a>. Setting the limit after any
  53           header octets have been parsed results in undefined behavior.
  54         </p>
  55 </div>
  56 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  57 <td align="left"></td>
  58 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  59       Falco<p>
  60         Distributed under the Boost Software License, Version 1.0. (See accompanying
  61         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>)
  62       </p>
  63 </div></td>
  64 </tr></table>
  65 <hr>
  66 <div class="spirit-nav">
  67 <a accesskey="p" href="got_some.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="is_done.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  68 </div>
  69 </body>
  70 </html>