1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::read_some (2 of 2 overloads)</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__read_some.html" title="http::read_some"> 9<link rel="prev" href="overload1.html" title="http::read_some (1 of 2 overloads)"> 10<link rel="next" href="../boost__beast__http__async_read_some.html" title="http::async_read_some"> 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="overload1.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__read_some.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__http__async_read_some.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__read_some.overload2"></a><a class="link" href="overload2.html" title="http::read_some (2 of 2 overloads)">http::read_some 28 (2 of 2 overloads)</a> 29</h5></div></div></div> 30<p> 31 Read part of a message from a stream using a parser. 32 </p> 33<h6> 34<a name="beast.ref.boost__beast__http__read_some.overload2.h0"></a> 35 <span class="phrase"><a name="beast.ref.boost__beast__http__read_some.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__read_some.overload2.synopsis">Synopsis</a> 36 </h6> 37<p> 38 Defined in header <code class="literal"><<a href="../../../../../../../boost/beast/http/read.hpp" target="_top">boost/beast/http/read.hpp</a>></code> 39 </p> 40<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 41 <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/SyncReadStream.html" target="_top"><span class="emphasis"><em>SyncReadStream</em></span></a><span class="special">,</span> 42 <span class="keyword">class</span> <a class="link" href="../../concepts/DynamicBuffer.html" title="DynamicBuffer"><span class="emphasis"><em>DynamicBuffer</em></span></a><span class="special">,</span> 43 <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">></span> 44<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 45<span class="identifier">read_some</span><span class="special">(</span> 46 <span class="identifier">SyncReadStream</span><span class="special">&</span> <span class="identifier">stream</span><span class="special">,</span> 47 <span class="identifier">DynamicBuffer</span><span class="special">&</span> <span class="identifier">buffer</span><span class="special">,</span> 48 <span class="identifier">basic_parser</span><span class="special"><</span> <span class="identifier">isRequest</span> <span class="special">>&</span> <span class="identifier">parser</span><span class="special">,</span> 49 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 50</pre> 51<h6> 52<a name="beast.ref.boost__beast__http__read_some.overload2.h1"></a> 53 <span class="phrase"><a name="beast.ref.boost__beast__http__read_some.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__read_some.overload2.description">Description</a> 54 </h6> 55<p> 56 This function is used to read part of a message from a stream into an instance 57 of <a class="link" href="../boost__beast__http__basic_parser.html" title="http::basic_parser"><code class="computeroutput"><span class="identifier">basic_parser</span></code></a>. The call will block 58 until one of the following conditions is true: 59 </p> 60<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 61<li class="listitem"> 62 A call to <a class="link" href="../boost__beast__http__basic_parser/put.html" title="http::basic_parser::put"><code class="computeroutput"><span class="identifier">basic_parser</span><span class="special">::</span><span class="identifier">put</span></code></a> with a non-empty buffer 63 sequence is successful. 64 </li> 65<li class="listitem"> 66 An error occurs. 67 </li> 68</ul></div> 69<p> 70 This operation is implemented in terms of one or more calls to the stream's 71 <code class="computeroutput"><span class="identifier">read_some</span></code> function. The 72 implementation may read additional bytes from the stream that lie past 73 the end of the message being read. These additional bytes are stored in 74 the dynamic buffer, which must be preserved for subsequent reads. If the 75 end of file error is received while reading from the stream, then the error 76 returned from this function will be: 77 </p> 78<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 79<li class="listitem"> 80 <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">end_of_stream</span></code></a> 81 if no bytes were parsed, or 82 </li> 83<li class="listitem"> 84 <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">partial_message</span></code></a> 85 if any bytes were parsed but the message was incomplete, otherwise: 86 </li> 87<li class="listitem"> 88 A successful result. The next attempt to read will return <a class="link" href="../boost__beast__http__error.html" title="http::error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">end_of_stream</span></code></a> 89 </li> 90</ul></div> 91<h6> 92<a name="beast.ref.boost__beast__http__read_some.overload2.h2"></a> 93 <span class="phrase"><a name="beast.ref.boost__beast__http__read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__read_some.overload2.parameters">Parameters</a> 94 </h6> 95<div class="informaltable"><table class="table"> 96<colgroup> 97<col> 98<col> 99</colgroup> 100<thead><tr> 101<th> 102 <p> 103 Name 104 </p> 105 </th> 106<th> 107 <p> 108 Description 109 </p> 110 </th> 111</tr></thead> 112<tbody> 113<tr> 114<td> 115 <p> 116 <code class="computeroutput"><span class="identifier">stream</span></code> 117 </p> 118 </td> 119<td> 120 <p> 121 The stream from which the data is to be read. The type must support 122 the <span class="emphasis"><em>SyncReadStream</em></span> requirements. 123 </p> 124 </td> 125</tr> 126<tr> 127<td> 128 <p> 129 <code class="computeroutput"><span class="identifier">buffer</span></code> 130 </p> 131 </td> 132<td> 133 <p> 134 Storage for additional bytes read by the implementation from 135 the stream. This is both an input and an output parameter; on 136 entry, the parser will be presented with any remaining data in 137 the dynamic buffer's readable bytes sequence first. The type 138 must meet the <span class="emphasis"><em>DynamicBuffer</em></span> requirements. 139 </p> 140 </td> 141</tr> 142<tr> 143<td> 144 <p> 145 <code class="computeroutput"><span class="identifier">parser</span></code> 146 </p> 147 </td> 148<td> 149 <p> 150 The parser to use. 151 </p> 152 </td> 153</tr> 154<tr> 155<td> 156 <p> 157 <code class="computeroutput"><span class="identifier">ec</span></code> 158 </p> 159 </td> 160<td> 161 <p> 162 Set to the error, if any occurred. 163 </p> 164 </td> 165</tr> 166</tbody> 167</table></div> 168<h6> 169<a name="beast.ref.boost__beast__http__read_some.overload2.h3"></a> 170 <span class="phrase"><a name="beast.ref.boost__beast__http__read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__read_some.overload2.return_value">Return 171 Value</a> 172 </h6> 173<p> 174 The number of bytes transferred from the stream. 175 </p> 176<h6> 177<a name="beast.ref.boost__beast__http__read_some.overload2.h4"></a> 178 <span class="phrase"><a name="beast.ref.boost__beast__http__read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__read_some.overload2.remarks">Remarks</a> 179 </h6> 180<p> 181 The function returns the total number of bytes transferred from the stream. 182 This may be zero for the case where there is sufficient pre-existing message 183 data in the dynamic buffer. 184 </p> 185</div> 186<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 187<td align="left"></td> 188<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 189 Falco<p> 190 Distributed under the Boost Software License, Version 1.0. (See accompanying 191 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>) 192 </p> 193</div></td> 194</tr></table> 195<hr> 196<div class="spirit-nav"> 197<a accesskey="p" href="overload1.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__read_some.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__http__async_read_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 198</div> 199</body> 200</html> 201
