read (6 of 12 overloads)

Attempt to read a certain amount of data from a stream before returning.

template<
    typename SyncReadStream,
    typename DynamicBuffer>
std::size_t read(
    SyncReadStream & s,
    DynamicBuffer && buffers,
    boost::system::error_code & ec,
    typename enable_if< is_dynamic_buffer< typename decay< DynamicBuffer >::type >::value >::type *  = 0);

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

The supplied buffer is full (that is, it has reached maximum size).
An error occurred.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s: The stream from which the data is to be read. The type must support the SyncReadStream concept.
buffers: The dynamic buffer sequence into which the data will be read.
ec: Set to indicate what error occurred, if any.

Return Value

The number of bytes transferred.

Remarks

This overload is equivalent to calling:

boost::asio::read(
    s, buffers,
    boost::asio::transfer_all(), ec);