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

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