Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
PrevUpHomeNext

buffered_write_stream

Adds buffering to the write-related operations of a stream.

template<
    typename Stream>
class buffered_write_stream :
  noncopyable
Types

Name

Description

lowest_layer_type

The type of the lowest layer.

next_layer_type

The type of the next layer.

Member Functions

Name

Description

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.

buffered_write_stream

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

close

Close the stream.

flush

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.

get_io_service

Get the io_service associated with the object.

in_avail

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

io_service

(Deprecated: use get_io_service().) Get the io_service associated with the object.

lowest_layer

Get a reference to the lowest layer.

next_layer

Get a reference to the next layer.

peek

Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.

read_some

Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.

write_some

Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.

Data Members

Name

Description

default_buffer_size

The default buffer size.

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

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.


PrevUpHomeNext