<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>read (12 of 16 overloads)</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../read.html" title="read">
<link rel="prev" href="overload11.html" title="read (11 of 16 overloads)">
<link rel="next" href="overload13.html" title="read (13 of 16 overloads)">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload11.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload13.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.read.overload12"></a><a class="link" href="overload12.html" title="read (12 of 16 overloads)">read (12 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"><span class="keyword">template</span><span class="special"><</span>
<span class="keyword">typename</span> <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="../CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a><span class="special">></span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read</span><span class="special">(</span>
<span class="identifier">SyncReadStream</span> <span class="special">&</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">,</span>
<span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
</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" type="disc">
<li class="listitem">
The supplied buffer is full (that is, it has reached maximum size).
</li>
<li class="listitem">
The completion_condition function object returns 0.
</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="asio.reference.read.overload12.h0"></a>
<span><a name="asio.reference.read.overload12.parameters"></a></span><a class="link" href="overload12.html#asio.reference.read.overload12.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<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">b</span></dt>
<dd><p>
The <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a> object into
which the data will be read.
</p></dd>
<dt><span class="term">completion_condition</span></dt>
<dd>
<p>
The function object to be called to determine whether the read operation
is complete. The signature of the function object must be:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">completion_condition</span><span class="special">(</span>
<span class="comment">// Result of latest read_some operation.</span>
<span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span>
<span class="comment">// Number of bytes transferred so far.</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span>
<span class="special">);</span>
</pre>
<p>
A return value of 0 indicates that the read operation is complete.
A non-zero return value indicates the maximum number of bytes to
be read on the next call to the stream's read_some function.
</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="asio.reference.read.overload12.h1"></a>
<span><a name="asio.reference.read.overload12.return_value"></a></span><a class="link" href="overload12.html#asio.reference.read.overload12.return_value">Return
Value</a>
</h6>
<p>
The number of bytes read. If an error occurs, returns the total number
of bytes successfully transferred prior to the error.
</p>
</div>
<div class="copyright-footer">Copyright © 2003-2023 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>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload11.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload13.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>