Boost C++ Libraries

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

Click here to view the latest version of this page.
PrevUpHomeNext

read_at (3 of 8 overloads)

Attempt to read a certain amount of data at the specified offset before returning.

template<
    typename SyncRandomAccessReadDevice,
    typename MutableBufferSequence,
    typename CompletionCondition>
std::size_t read_at(
    SyncRandomAccessReadDevice & d,
    boost::uint64_t offset,
    const MutableBufferSequence & buffers,
    CompletionCondition completion_condition);

This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:

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

Parameters

d

The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.

offset

The offset at which the data will be read.

buffers

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 device.

completion_condition

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

std::size_t completion_condition(
  // Result of latest read_some_at operation.
  const boost::system::error_code& error,

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

A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read_some_at function.

Return Value

The number of bytes transferred.

Exceptions

boost::system::system_error

Thrown on failure.

Example

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

boost::asio::read_at(d, 42, boost::asio::buffer(data, size),
    boost::asio::transfer_at_least(32)); 

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


PrevUpHomeNext