boost::asio::buffered_stream

Adds buffering to the read‐ and write‐related operations of a stream.

Synopsis

Declared in <boost/asio/buffered_stream.hpp>

template<typename Stream>
class buffered_stream;

Types

Name

Description

executor_type

The type of the executor associated with the object.

lowest_layer_type

The type of the lowest layer.

next_layer_type

The type of the next layer.

Member Functions

Name

Description

buffered_stream [constructor]

Construct, passing the specified argument to initialise the next layer.

async_fill

Start an asynchronous fill.

async_flush

Start an asynchronous flush.

async_read_some

Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.

async_write_some

Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.

close

Close the stream.

fill

fill overloads

flush

flush overloads

get_executor

Get the executor associated with the object.

in_avail

Determine the amount of data that may be read without blocking.

lowest_layer

lowest_layer overloads

next_layer

Get a reference to the next layer.

peek

peek overloads

read_some

read_some overloads

write_some

write_some overloads

Description

The buffered_stream class template can be used to add buffering to the synchronous and asynchronous read and write operations of a stream.

Thread Safety

Distinct objects: Safe. Shared objects: Unsafe.

Concepts:

AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream.

Created with MrDocs

Edit this Page