Urdl C++ Library

PrevUpHomeNext
read_stream::read_some (2 of 2 overloads)

Reads some data from the stream.

template<
    typename MutableBufferSequence>
std::size_t read_some(
    const MutableBufferSequence & buffers,
    boost::system::error_code & ec);

Parameters

buffers

One or more buffers into which the data will be read. The type must meet the requirements for MutableBufferSequence, as defined in the Boost.Asio documentation.

ec

Set to indicate what error occurred, if any. An error code of boost::asio::error::eof indicates that the end of the URL content has been reached.

Return Value

The number of bytes read.

Remarks

This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

The read_some operation may not read all of the requested number of bytes. Consider using the boost::asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Example

To read into a single data buffer use the boost::asio::buffer function as follows:

read_stream.read_some(boost::asio::buffer(data, size));

See the documentation for the boost::asio::buffer function for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.


PrevUpHomeNext