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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::parser::put_eof</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="put.html" title="http::parser::put">
  10 <link rel="next" href="release.html" title="http::parser::release">
  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="put.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="release.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.put_eof"></a><a class="link" href="put_eof.html" title="http::parser::put_eof">http::parser::put_eof</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="idm45873493134480"></a>
  34 Inform the parser that the end of stream was reached.
  35         </p>
  36 <h6>
  37 <a name="beast.ref.boost__beast__http__parser.put_eof.h0"></a>
  38           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.put_eof.synopsis"></a></span><a class="link" href="put_eof.html#beast.ref.boost__beast__http__parser.put_eof.synopsis">Synopsis</a>
  39         </h6>
  40 <pre class="programlisting"><span class="keyword">void</span>
  41 <span class="identifier">put_eof</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__parser.put_eof.h1"></a>
  46           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.put_eof.description"></a></span><a class="link" href="put_eof.html#beast.ref.boost__beast__http__parser.put_eof.description">Description</a>
  47         </h6>
  48 <p>
  49           In certain cases, HTTP needs to know where the end of the stream is. For
  50           example, sometimes servers send responses without Content-Length and expect
  51           the client to consume input (for the body) until EOF. Callbacks and errors
  52           will still be processed as usual. This is typically called when a read
  53           from the underlying stream object sets the error code to <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code>.
  54         </p>
  55 <h6>
  56 <a name="beast.ref.boost__beast__http__parser.put_eof.h2"></a>
  57           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.put_eof.remarks"></a></span><a class="link" href="put_eof.html#beast.ref.boost__beast__http__parser.put_eof.remarks">Remarks</a>
  58         </h6>
  59 <p>
  60           Only valid after parsing a complete header.
  61         </p>
  62 <h6>
  63 <a name="beast.ref.boost__beast__http__parser.put_eof.h3"></a>
  64           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.put_eof.parameters"></a></span><a class="link" href="put_eof.html#beast.ref.boost__beast__http__parser.put_eof.parameters">Parameters</a>
  65         </h6>
  66 <div class="informaltable"><table class="table">
  67 <colgroup>
  68 <col>
  69 <col>
  70 </colgroup>
  71 <thead><tr>
  72 <th>
  73                   <p>
  74                     Name
  75                   </p>
  76                 </th>
  77 <th>
  78                   <p>
  79                     Description
  80                   </p>
  81                 </th>
  82 </tr></thead>
  83 <tbody><tr>
  84 <td>
  85                   <p>
  86                     <code class="computeroutput"><span class="identifier">ec</span></code>
  87                   </p>
  88                 </td>
  89 <td>
  90                   <p>
  91                     Set to the error, if any occurred.
  92                   </p>
  93                 </td>
  94 </tr></tbody>
  95 </table></div>
  96 </div>
  97 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  98 <td align="left"></td>
  99 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 100       Falco<p>
 101         Distributed under the Boost Software License, Version 1.0. (See accompanying
 102         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>)
 103       </p>
 104 </div></td>
 105 </tr></table>
 106 <hr>
 107 <div class="spirit-nav">
 108 <a accesskey="p" href="put.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="release.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 109 </div>
 110 </body>
 111 </html>