115 lines
5.6 KiB
HTML
115 lines
5.6 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>read (14 of 16 overloads)</title>
|
|
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
|
|
<link rel="up" href="../read.html" title="read">
|
|
<link rel="prev" href="overload13.html" title="read (13 of 16 overloads)">
|
|
<link rel="next" href="overload15.html" title="read (15 of 16 overloads)">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr>
|
|
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
|
|
<td align="center"><a href="../../../../../index.html">Home</a></td>
|
|
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
|
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="overload13.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload15.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="boost_asio.reference.read.overload14"></a><a class="link" href="overload14.html" title="read (14 of 16 overloads)">read (14 of 16
|
|
overloads)</a>
|
|
</h4></div></div></div>
|
|
<p>
|
|
Attempt to read a certain amount of data from a stream before returning.
|
|
</p>
|
|
<pre class="programlisting">template<
|
|
typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
|
|
typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>>
|
|
std::size_t read(
|
|
SyncReadStream & s,
|
|
DynamicBuffer_v2 buffers,
|
|
boost::system::error_code & ec,
|
|
typename constraint< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type = 0);
|
|
</pre>
|
|
<p>
|
|
This function is used to read a certain number of bytes of data from a
|
|
stream. The call will block until one of the following conditions is true:
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
|
<li class="listitem">
|
|
The supplied buffer is full (that is, it has reached maximum size).
|
|
</li>
|
|
<li class="listitem">
|
|
An error occurred.
|
|
</li>
|
|
</ul></div>
|
|
<p>
|
|
This operation is implemented in terms of zero or more calls to the stream's
|
|
read_some function.
|
|
</p>
|
|
<h6>
|
|
<a name="boost_asio.reference.read.overload14.h0"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.read.overload14.parameters"></a></span><a class="link" href="overload14.html#boost_asio.reference.read.overload14.parameters">Parameters</a>
|
|
</h6>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl class="variablelist">
|
|
<dt><span class="term">s</span></dt>
|
|
<dd><p>
|
|
The stream from which the data is to be read. The type must support
|
|
the SyncReadStream concept.
|
|
</p></dd>
|
|
<dt><span class="term">buffers</span></dt>
|
|
<dd><p>
|
|
The dynamic buffer sequence into which the data will be read.
|
|
</p></dd>
|
|
<dt><span class="term">ec</span></dt>
|
|
<dd><p>
|
|
Set to indicate what error occurred, if any.
|
|
</p></dd>
|
|
</dl>
|
|
</div>
|
|
<h6>
|
|
<a name="boost_asio.reference.read.overload14.h1"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.read.overload14.return_value"></a></span><a class="link" href="overload14.html#boost_asio.reference.read.overload14.return_value">Return
|
|
Value</a>
|
|
</h6>
|
|
<p>
|
|
The number of bytes transferred.
|
|
</p>
|
|
<h6>
|
|
<a name="boost_asio.reference.read.overload14.h2"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.read.overload14.remarks"></a></span><a class="link" href="overload14.html#boost_asio.reference.read.overload14.remarks">Remarks</a>
|
|
</h6>
|
|
<p>
|
|
This overload is equivalent to calling:
|
|
</p>
|
|
<pre class="programlisting">boost::asio::read(
|
|
s, buffers,
|
|
boost::asio::transfer_all(), ec);
|
|
</pre>
|
|
</div>
|
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
|
<td align="left"></td>
|
|
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
|
|
M. Kohlhoff<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
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>)
|
|
</p>
|
|
</div></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="overload13.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload15.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|