1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ssl_stream::read_some (1 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="ssl_stream::read_some"> 9<link rel="prev" href="../read_some.html" title="ssl_stream::read_some"> 10<link rel="next" href="overload2.html" title="ssl_stream::read_some (2 of 2 overloads)"> 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="../read_some.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="overload2.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__ssl_stream.read_some.overload1"></a><a class="link" href="overload1.html" title="ssl_stream::read_some (1 of 2 overloads)">ssl_stream::read_some 28 (1 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__ssl_stream.read_some.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.read_some.overload1.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</pre> 41<h7><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.h1"></a> 42 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.read_some.overload1.description">Description</a> 43 </h7><p> 44 This function is used to read data from the stream. The function call 45 will block until one or more bytes of data has been read successfully, 46 or until an error occurs. 47 </p> 48<h7><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.h2"></a> 49 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.read_some.overload1.parameters">Parameters</a> 50 </h7><div class="informaltable"><table class="table"> 51<colgroup> 52<col> 53<col> 54</colgroup> 55<thead><tr> 56<th> 57 <p> 58 Name 59 </p> 60 </th> 61<th> 62 <p> 63 Description 64 </p> 65 </th> 66</tr></thead> 67<tbody><tr> 68<td> 69 <p> 70 <code class="computeroutput"><span class="identifier">buffers</span></code> 71 </p> 72 </td> 73<td> 74 <p> 75 The buffers into which the data will be read. 76 </p> 77 </td> 78</tr></tbody> 79</table></div> 80<h7><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.h3"></a> 81 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.read_some.overload1.return_value">Return 82 Value</a> 83 </h7><p> 84 The number of bytes read. 85 </p> 86<h7><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.h4"></a> 87 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.read_some.overload1.exceptions">Exceptions</a> 88 </h7><div class="informaltable"><table class="table"> 89<colgroup> 90<col> 91<col> 92</colgroup> 93<thead><tr> 94<th> 95 <p> 96 Type 97 </p> 98 </th> 99<th> 100 <p> 101 Thrown On 102 </p> 103 </th> 104</tr></thead> 105<tbody><tr> 106<td> 107 <p> 108 <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">system_error</span></code> 109 </p> 110 </td> 111<td> 112 <p> 113 Thrown on failure. 114 </p> 115 </td> 116</tr></tbody> 117</table></div> 118<h7><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.h5"></a> 119 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.read_some.overload1.remarks">Remarks</a> 120 </h7><p> 121 The <code class="computeroutput"><span class="identifier">read_some</span></code> operation 122 may not read all of the requested number of bytes. Consider using the 123 <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> 124 function if you need to ensure that the requested amount of data is read 125 before the blocking operation completes. 126 </p> 127</div> 128<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 129<td align="left"></td> 130<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 131 Falco<p> 132 Distributed under the Boost Software License, Version 1.0. (See accompanying 133 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>) 134 </p> 135</div></td> 136</tr></table> 137<hr> 138<div class="spirit-nav"> 139<a accesskey="p" href="../read_some.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 140</div> 141</body> 142</html> 143
