160 lines
15 KiB
HTML
160 lines
15 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>async_read</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="../reference.html" title="Reference">
|
|
<link rel="prev" href="async_initiate.html" title="async_initiate">
|
|
<link rel="next" href="async_read/overload1.html" title="async_read (1 of 8 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="async_initiate.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="async_read/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="boost_asio.reference.async_read"></a><a class="link" href="async_read.html" title="async_read">async_read</a>
|
|
</h3></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="boost_asio.indexterm.async_read"></a>
|
|
The <code class="computeroutput">async_read</code> function
|
|
is a composed asynchronous operation that reads a certain amount of data
|
|
from a stream before completion.
|
|
</p>
|
|
<p>
|
|
Start an asynchronous operation to read a certain amount of data from a stream.
|
|
</p>
|
|
<pre class="programlisting">template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload1.html" title="async_read (1 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
const MutableBufferSequence & buffers,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_mutable_buffer_sequence< MutableBufferSequence >::value >::type = 0);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload1.html" title="async_read (1 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
|
|
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload2.html" title="async_read (2 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
const MutableBufferSequence & buffers,
|
|
CompletionCondition completion_condition,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_mutable_buffer_sequence< MutableBufferSequence >::value >::type = 0);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload2.html" title="async_read (2 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload3.html" title="async_read (3 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
DynamicBuffer_v1 && buffers,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value >::type = 0,
|
|
typename constraint< !is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type = 0);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload3.html" title="async_read (3 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename <a class="link" href="DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>,
|
|
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload4.html" title="async_read (4 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
DynamicBuffer_v1 && buffers,
|
|
CompletionCondition completion_condition,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value >::type = 0,
|
|
typename constraint< !is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type = 0);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload4.html" title="async_read (4 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename Allocator,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload5.html" title="async_read (5 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
basic_streambuf< Allocator > & b,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload5.html" title="async_read (5 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename Allocator,
|
|
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload6.html" title="async_read (6 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
basic_streambuf< Allocator > & b,
|
|
CompletionCondition completion_condition,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload6.html" title="async_read (6 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload7.html" title="async_read (7 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
DynamicBuffer_v2 buffers,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type = 0);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload7.html" title="async_read (7 of 8 overloads)">more...</a></em></span>
|
|
|
|
template<
|
|
typename <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a>,
|
|
typename <a class="link" href="DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>,
|
|
typename <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>,
|
|
typename <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
|
|
<a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_read/overload8.html" title="async_read (8 of 8 overloads)">async_read</a>(
|
|
AsyncReadStream & s,
|
|
DynamicBuffer_v2 buffers,
|
|
CompletionCondition completion_condition,
|
|
ReadHandler && handler = <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
|
|
typename constraint< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type = 0);
|
|
<span class="emphasis"><em>» <a class="link" href="async_read/overload8.html" title="async_read (8 of 8 overloads)">more...</a></em></span>
|
|
</pre>
|
|
<h5>
|
|
<a name="boost_asio.reference.async_read.h0"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.async_read.requirements"></a></span><a class="link" href="async_read.html#boost_asio.reference.async_read.requirements">Requirements</a>
|
|
</h5>
|
|
<p>
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/read.hpp</code>
|
|
</p>
|
|
<p>
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
|
|
</p>
|
|
</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="async_initiate.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="async_read/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|