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