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

This is the documentation for an old version of Boost. Click here to view this page for the latest version.

read (3 of 6 overloads)

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

    typename SyncReadStream,
    typename MutableBufferSequence,
    typename CompletionCondition>
std::size_t read(
    SyncReadStream & s,
    const MutableBufferSequence & buffers,
    CompletionCondition completion_condition,
    boost::system::error_code & ec);

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:

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



The stream from which the data is to be read. The type must support the SyncReadStream concept.


One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.


The function object to be called to determine whether the read operation is complete. The signature of the function object must be:

bool completion_condition(
  const boost::system::error_code& error, // Result of latest read_some
                                          // operation.

  std::size_t bytes_transferred           // Number of bytes transferred
                                          // so far.

A return value of true indicates that the read operation is complete. False indicates that further calls to the stream's read_some function are required.


Set to indicate what error occurred, if any.

Return Value

The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.