141 lines
8.9 KiB
HTML
141 lines
8.9 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>read (3 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="overload2.html" title="read (2 of 16 overloads)">
|
|
<link rel="next" href="overload4.html" title="read (4 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="overload2.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="overload4.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.overload3"></a><a class="link" href="overload3.html" title="read (3 of 16 overloads)">read (3 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> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><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="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span>
|
|
<span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special"><</span> <span class="identifier">is_mutable_buffer_sequence</span><span class="special"><</span> <span class="identifier">MutableBufferSequence</span> <span class="special">>::</span><span class="identifier">value</span> <span class="special">>::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</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 buffers are full. That is, the bytes transferred is equal
|
|
to the sum of the buffer sizes.
|
|
</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.overload3.h0"></a>
|
|
<span><a name="asio.reference.read.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.read.overload3.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">buffers</span></dt>
|
|
<dd><p>
|
|
One or more buffers into which the data will be read. The sum of
|
|
the buffer sizes indicates the maximum number of bytes to read from
|
|
the stream.
|
|
</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>
|
|
</dl>
|
|
</div>
|
|
<h6>
|
|
<a name="asio.reference.read.overload3.h1"></a>
|
|
<span><a name="asio.reference.read.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.read.overload3.return_value">Return
|
|
Value</a>
|
|
</h6>
|
|
<p>
|
|
The number of bytes transferred.
|
|
</p>
|
|
<h6>
|
|
<a name="asio.reference.read.overload3.h2"></a>
|
|
<span><a name="asio.reference.read.overload3.exceptions"></a></span><a class="link" href="overload3.html#asio.reference.read.overload3.exceptions">Exceptions</a>
|
|
</h6>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl>
|
|
<dt><span class="term">asio::system_error</span></dt>
|
|
<dd><p>
|
|
Thrown on failure.
|
|
</p></dd>
|
|
</dl>
|
|
</div>
|
|
<h6>
|
|
<a name="asio.reference.read.overload3.h3"></a>
|
|
<span><a name="asio.reference.read.overload3.example"></a></span><a class="link" href="overload3.html#asio.reference.read.overload3.example">Example</a>
|
|
</h6>
|
|
<p>
|
|
To read into a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows:
|
|
</p>
|
|
<pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">read</span><span class="special">(</span><span class="identifier">s</span><span class="special">,</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span>
|
|
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">transfer_at_least</span><span class="special">(</span><span class="number">32</span><span class="special">));</span>
|
|
</pre>
|
|
<p>
|
|
See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
|
|
documentation for information on reading into multiple buffers in one go,
|
|
and how to use it with arrays, boost::array or std::vector.
|
|
</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="overload2.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="overload4.html"><img src="../../../next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|