1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>flat_stream::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="../read_some.html" title="flat_stream::read_some"> 9<link rel="prev" href="overload1.html" title="flat_stream::read_some (1 of 2 overloads)"> 10<link rel="next" href="../async_read_some.html" title="flat_stream::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="../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="../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><h6 class="title"> 27<a name="beast.ref.boost__beast__flat_stream.read_some.overload2"></a><a class="link" href="overload2.html" title="flat_stream::read_some (2 of 2 overloads)">flat_stream::read_some 28 (2 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Read some data from the stream. 32 </p> 33<h7><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__flat_stream.read_some.overload2.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/MutableBufferSequence.html" target="_top"><span class="emphasis"><em>MutableBufferSequence</em></span></a><span class="special">></span> 37<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 38<span class="identifier">read_some</span><span class="special">(</span> 39 <span class="identifier">MutableBufferSequence</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> 40 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 41</pre> 42<h7><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.h1"></a> 43 <span class="phrase"><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__flat_stream.read_some.overload2.description">Description</a> 44 </h7><p> 45 This function is used to read data from the stream. The function call 46 will block until one or more bytes of data has been read successfully, 47 or until an error occurs. 48 </p> 49<h7><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.h2"></a> 50 <span class="phrase"><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__flat_stream.read_some.overload2.parameters">Parameters</a> 51 </h7><div class="informaltable"><table class="table"> 52<colgroup> 53<col> 54<col> 55</colgroup> 56<thead><tr> 57<th> 58 <p> 59 Name 60 </p> 61 </th> 62<th> 63 <p> 64 Description 65 </p> 66 </th> 67</tr></thead> 68<tbody> 69<tr> 70<td> 71 <p> 72 <code class="computeroutput"><span class="identifier">buffers</span></code> 73 </p> 74 </td> 75<td> 76 <p> 77 The buffers into which the data will be read. 78 </p> 79 </td> 80</tr> 81<tr> 82<td> 83 <p> 84 <code class="computeroutput"><span class="identifier">ec</span></code> 85 </p> 86 </td> 87<td> 88 <p> 89 Set to indicate what error occurred, if any. 90 </p> 91 </td> 92</tr> 93</tbody> 94</table></div> 95<h7><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.h3"></a> 96 <span class="phrase"><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__flat_stream.read_some.overload2.return_value">Return 97 Value</a> 98 </h7><p> 99 The number of bytes read. 100 </p> 101<h7><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.h4"></a> 102 <span class="phrase"><a name="beast.ref.boost__beast__flat_stream.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__flat_stream.read_some.overload2.remarks">Remarks</a> 103 </h7><p> 104 The <code class="computeroutput"><span class="identifier">read_some</span></code> operation 105 may not read all of the requested number of bytes. Consider using the 106 function <a class="link" href="../../boost__beast__file_mode.html" title="file_mode"><code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">read</span></code></a> if you need to ensure that 107 the requested amount of data is read before the blocking operation completes. 108 </p> 109</div> 110<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 111<td align="left"></td> 112<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 113 Falco<p> 114 Distributed under the Boost Software License, Version 1.0. (See accompanying 115 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>) 116 </p> 117</div></td> 118</tr></table> 119<hr> 120<div class="spirit-nav"> 121<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="../async_read_some.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 122</div> 123</body> 124</html> 125
