Adds buffering to the read-related operations of a stream. More...
#include <buffered_read_stream.hpp>
Classes | |
| class | fill_handler |
| class | read_some_handler |
Public Types | |
| typedef next_layer_type::lowest_layer_type | lowest_layer_type |
| The type of the lowest layer. | |
| typedef boost::remove_reference < Stream >::type | next_layer_type |
| The type of the next layer. | |
Public Member Functions | |
| template<typename ReadHandler > | |
| void | async_fill (ReadHandler handler) |
| Start an asynchronous fill. | |
| template<typename MutableBufferSequence , typename ReadHandler > | |
| void | async_read_some (const MutableBufferSequence &buffers, ReadHandler handler) |
| template<typename ConstBufferSequence , typename WriteHandler > | |
| void | async_write_some (const ConstBufferSequence &buffers, WriteHandler handler) |
| BOOST_STATIC_CONSTANT (std::size_t, default_buffer_size=1024) | |
| template<typename Arg > | |
| buffered_read_stream (Arg &a) | |
| Construct, passing the specified argument to initialise the next layer. | |
| template<typename Arg > | |
| buffered_read_stream (Arg &a, std::size_t buffer_size) | |
| Construct, passing the specified argument to initialise the next layer. | |
| void | close () |
| Close the stream. | |
| asio::error_code | close (asio::error_code &ec) |
| Close the stream. | |
| std::size_t | fill () |
| std::size_t | fill (asio::error_code &ec) |
| asio::io_service & | get_io_service () |
| Get the io_service associated with the object. | |
| std::size_t | in_avail () |
| Determine the amount of data that may be read without blocking. | |
| std::size_t | in_avail (asio::error_code &ec) |
| Determine the amount of data that may be read without blocking. | |
| asio::io_service & | io_service () |
| lowest_layer_type & | lowest_layer () |
| Get a reference to the lowest layer. | |
| next_layer_type & | next_layer () |
| Get a reference to the next layer. | |
| template<typename MutableBufferSequence > | |
| std::size_t | peek (const MutableBufferSequence &buffers) |
| template<typename MutableBufferSequence > | |
| std::size_t | peek (const MutableBufferSequence &buffers, asio::error_code &ec) |
| template<typename MutableBufferSequence > | |
| std::size_t | read_some (const MutableBufferSequence &buffers) |
| template<typename MutableBufferSequence > | |
| std::size_t | read_some (const MutableBufferSequence &buffers, asio::error_code &ec) |
| template<typename ConstBufferSequence > | |
| std::size_t | write_some (const ConstBufferSequence &buffers) |
| template<typename ConstBufferSequence > | |
| std::size_t | write_some (const ConstBufferSequence &buffers, asio::error_code &ec) |
Private Member Functions | |
| template<typename MutableBufferSequence > | |
| std::size_t | copy (const MutableBufferSequence &buffers) |
| template<typename MutableBufferSequence > | |
| std::size_t | peek_copy (const MutableBufferSequence &buffers) |
Private Attributes | |
| Stream | next_layer_ |
| The next layer. | |
| detail::buffered_stream_storage | storage_ |
Adds buffering to the read-related operations of a stream.
The buffered_read_stream class template can be used to add buffering to the synchronous and asynchronous read operations of a stream.
Definition at line 51 of file buffered_read_stream.hpp.
| typedef next_layer_type::lowest_layer_type asio::buffered_read_stream< Stream >::lowest_layer_type |
The type of the lowest layer.
Definition at line 59 of file buffered_read_stream.hpp.
| typedef boost::remove_reference<Stream>::type asio::buffered_read_stream< Stream >::next_layer_type |
The type of the next layer.
Definition at line 56 of file buffered_read_stream.hpp.
| asio::buffered_read_stream< Stream >::buffered_read_stream | ( | Arg & | a | ) | [inline, explicit] |
Construct, passing the specified argument to initialise the next layer.
Definition at line 70 of file buffered_read_stream.hpp.
| asio::buffered_read_stream< Stream >::buffered_read_stream | ( | Arg & | a, |
| std::size_t | buffer_size | ||
| ) | [inline] |
Construct, passing the specified argument to initialise the next layer.
Definition at line 78 of file buffered_read_stream.hpp.
| void asio::buffered_read_stream< Stream >::async_fill | ( | ReadHandler | handler | ) | [inline] |
Start an asynchronous fill.
Definition at line 209 of file buffered_read_stream.hpp.
| void asio::buffered_read_stream< Stream >::async_read_some | ( | const MutableBufferSequence & | buffers, |
| ReadHandler | handler | ||
| ) | [inline] |
Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.
Definition at line 299 of file buffered_read_stream.hpp.
| void asio::buffered_read_stream< Stream >::async_write_some | ( | const ConstBufferSequence & | buffers, |
| WriteHandler | handler | ||
| ) | [inline] |
Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.
Definition at line 141 of file buffered_read_stream.hpp.
| asio::buffered_read_stream< Stream >::BOOST_STATIC_CONSTANT | ( | std::size_t | , |
| default_buffer_size | = 1024 |
||
| ) |
| void asio::buffered_read_stream< Stream >::close | ( | ) | [inline] |
Close the stream.
Definition at line 110 of file buffered_read_stream.hpp.
| asio::error_code asio::buffered_read_stream< Stream >::close | ( | asio::error_code & | ec | ) | [inline] |
Close the stream.
Definition at line 116 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::copy | ( | const MutableBufferSequence & | buffers | ) | [inline, private] |
Copy data out of the internal buffer to the specified target buffer. Returns the number of bytes copied.
Definition at line 354 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::fill | ( | ) | [inline] |
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.
Definition at line 149 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::fill | ( | asio::error_code & | ec | ) | [inline] |
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.
Definition at line 164 of file buffered_read_stream.hpp.
| asio::io_service& asio::buffered_read_stream< Stream >::get_io_service | ( | ) | [inline] |
Get the io_service associated with the object.
Definition at line 104 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::in_avail | ( | ) | [inline] |
Determine the amount of data that may be read without blocking.
Definition at line 338 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::in_avail | ( | asio::error_code & | ec | ) | [inline] |
Determine the amount of data that may be read without blocking.
Definition at line 344 of file buffered_read_stream.hpp.
| asio::io_service& asio::buffered_read_stream< Stream >::io_service | ( | ) | [inline] |
(Deprecated: use get_io_service().) Get the io_service associated with the object.
Definition at line 98 of file buffered_read_stream.hpp.
| lowest_layer_type& asio::buffered_read_stream< Stream >::lowest_layer | ( | ) | [inline] |
Get a reference to the lowest layer.
Definition at line 91 of file buffered_read_stream.hpp.
| next_layer_type& asio::buffered_read_stream< Stream >::next_layer | ( | ) | [inline] |
Get a reference to the next layer.
Definition at line 85 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::peek | ( | const MutableBufferSequence & | buffers | ) | [inline] |
Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
Definition at line 318 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::peek | ( | const MutableBufferSequence & | buffers, |
| asio::error_code & | ec | ||
| ) | [inline] |
Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
Definition at line 328 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::peek_copy | ( | const MutableBufferSequence & | buffers | ) | [inline, private] |
Copy data from the internal buffer to the specified target buffer, without removing the data from the internal buffer. Returns the number of bytes copied.
Definition at line 381 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::read_some | ( | const MutableBufferSequence & | buffers | ) | [inline] |
Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
Definition at line 224 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::read_some | ( | const MutableBufferSequence & | buffers, |
| asio::error_code & | ec | ||
| ) | [inline] |
Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
Definition at line 234 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::write_some | ( | const ConstBufferSequence & | buffers | ) | [inline] |
Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
Definition at line 124 of file buffered_read_stream.hpp.
| std::size_t asio::buffered_read_stream< Stream >::write_some | ( | const ConstBufferSequence & | buffers, |
| asio::error_code & | ec | ||
| ) | [inline] |
Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
Definition at line 132 of file buffered_read_stream.hpp.
Stream asio::buffered_read_stream< Stream >::next_layer_ [private] |
The next layer.
Definition at line 404 of file buffered_read_stream.hpp.
detail::buffered_stream_storage asio::buffered_read_stream< Stream >::storage_ [private] |
Definition at line 407 of file buffered_read_stream.hpp.
