<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>buffered_stream</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="../reference.html" title="Reference">
<link rel="prev" href="buffered_read_stream/write_some/overload2.html" title="buffered_read_stream::write_some (2 of 2 overloads)">
<link rel="next" href="buffered_stream/async_fill.html" title="buffered_stream::async_fill">
<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="buffered_read_stream/write_some/overload2.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="buffered_stream/async_fill.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.buffered_stream"></a><a class="link" href="buffered_stream.html" title="buffered_stream">buffered_stream</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.buffered_stream"></a>
</p>
<p>
Adds buffering to the read- and write-related operations of a stream.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
<span class="keyword">typename</span> <span class="identifier">Stream</span><span class="special">></span>
<span class="keyword">class</span> <span class="identifier">buffered_stream</span> <span class="special">:</span>
<span class="identifier">noncopyable</span>
</pre>
<h5>
<a name="asio.reference.buffered_stream.h0"></a>
<span><a name="asio.reference.buffered_stream.types"></a></span><a class="link" href="buffered_stream.html#asio.reference.buffered_stream.types">Types</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/executor_type.html" title="buffered_stream::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/lowest_layer_type.html" title="buffered_stream::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the lowest layer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/next_layer_type.html" title="buffered_stream::next_layer_type"><span class="bold"><strong>next_layer_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the next layer.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.buffered_stream.h1"></a>
<span><a name="asio.reference.buffered_stream.member_functions"></a></span><a class="link" href="buffered_stream.html#asio.reference.buffered_stream.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/async_fill.html" title="buffered_stream::async_fill"><span class="bold"><strong>async_fill</strong></span></a>
</p>
</td>
<td>
<p>
Start an asynchronous fill.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/async_flush.html" title="buffered_stream::async_flush"><span class="bold"><strong>async_flush</strong></span></a>
</p>
</td>
<td>
<p>
Start an asynchronous flush.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/async_read_some.html" title="buffered_stream::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a>
</p>
</td>
<td>
<p>
Start an asynchronous read. The buffer into which the data will
be read must be valid for the lifetime of the asynchronous operation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/async_write_some.html" title="buffered_stream::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a>
</p>
</td>
<td>
<p>
Start an asynchronous write. The data being written must be valid
for the lifetime of the asynchronous operation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/buffered_stream.html" title="buffered_stream::buffered_stream"><span class="bold"><strong>buffered_stream</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct, passing the specified argument to initialise the next
layer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/close.html" title="buffered_stream::close"><span class="bold"><strong>close</strong></span></a>
</p>
</td>
<td>
<p>
Close the stream.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/fill.html" title="buffered_stream::fill"><span class="bold"><strong>fill</strong></span></a>
</p>
</td>
<td>
<p>
Fill the buffer with some data. Returns the number of bytes placed
in the buffer as a result of the operation. Throws an exception
on failure. <br> <span class="silver"> —</span><br> Fill the buffer with some data. Returns
the number of bytes placed in the buffer as a result of the operation,
or 0 if an error occurred.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/flush.html" title="buffered_stream::flush"><span class="bold"><strong>flush</strong></span></a>
</p>
</td>
<td>
<p>
Flush all data from the buffer to the next layer. Returns the number
of bytes written to the next layer on the last write operation.
Throws an exception on failure. <br> <span class="silver"> —</span><br> Flush all data from
the buffer to the next layer. Returns the number of bytes written
to the next layer on the last write operation, or 0 if an error
occurred.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/get_executor.html" title="buffered_stream::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
</p>
</td>
<td>
<p>
Get the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/in_avail.html" title="buffered_stream::in_avail"><span class="bold"><strong>in_avail</strong></span></a>
</p>
</td>
<td>
<p>
Determine the amount of data that may be read without blocking.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/lowest_layer.html" title="buffered_stream::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
</p>
</td>
<td>
<p>
Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const
reference to the lowest layer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/next_layer.html" title="buffered_stream::next_layer"><span class="bold"><strong>next_layer</strong></span></a>
</p>
</td>
<td>
<p>
Get a reference to the next layer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/peek.html" title="buffered_stream::peek"><span class="bold"><strong>peek</strong></span></a>
</p>
</td>
<td>
<p>
Peek at the incoming data on the stream. Returns the number of
bytes read. Throws an exception on failure. <br> <span class="silver"> —</span><br> Peek
at the incoming data on the stream. Returns the number of bytes
read, or 0 if an error occurred.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/read_some.html" title="buffered_stream::read_some"><span class="bold"><strong>read_some</strong></span></a>
</p>
</td>
<td>
<p>
Read some data from the stream. Returns the number of bytes read.
Throws an exception on failure. <br> <span class="silver"> —</span><br> Read some data from
the stream. Returns the number of bytes read or 0 if an error occurred.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffered_stream/write_some.html" title="buffered_stream::write_some"><span class="bold"><strong>write_some</strong></span></a>
</p>
</td>
<td>
<p>
Write the given data to the stream. Returns the number of bytes
written. Throws an exception on failure. <br> <span class="silver"> —</span><br> Write the
given data to the stream. Returns the number of bytes written,
or 0 if an error occurred.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="buffered_stream.html" title="buffered_stream"><code class="computeroutput"><span class="identifier">buffered_stream</span></code></a>
class template can be used to add buffering to the synchronous and asynchronous
read and write operations of a stream.
</p>
<h5>
<a name="asio.reference.buffered_stream.h2"></a>
<span><a name="asio.reference.buffered_stream.thread_safety"></a></span><a class="link" href="buffered_stream.html#asio.reference.buffered_stream.thread_safety">Thread
Safety</a>
</h5>
<p>
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<p>
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
</p>
<h5>
<a name="asio.reference.buffered_stream.h3"></a>
<span><a name="asio.reference.buffered_stream.requirements"></a></span><a class="link" href="buffered_stream.html#asio.reference.buffered_stream.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/buffered_stream.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</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="buffered_read_stream/write_some/overload2.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="buffered_stream/async_fill.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>