...one of the most highly
regarded and expertly designed C++ library projects in the
world. — Herb Sutter and Andrei
template< typename MutableBufferSequence, typename ReadHandler = DEFAULT> DEDUCED async_read_some( const MutableBufferSequence & buffers, ReadHandler && handler = DEFAULT);
This function is used to asynchronously read data from the stream socket. The function call always returns immediately.
One or more buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.
The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
void handler( const boost::system::error_code& error, // Result of operation. std::size_t bytes_transferred // Number of bytes read. );
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
On immediate completion, invocation of the handler will be performed
in a manner equivalent to using
The read operation may not read all of the requested number of bytes. Consider
function if you need to ensure that the requested amount of data is read
before the asynchronous operation completes.
To read into a single data buffer use the
function as follows:
socket.async_read_some(boost::asio::buffer(data, size), handler);
documentation for information on reading into multiple buffers in one go,
and how to use it with arrays, boost::array or std::vector.
On POSIX or Windows operating systems, this asynchronous operation supports
cancellation for the following