boost::asio::async_read_at

Start an asynchronous operation to read a certain amount of data at the specified offset.

Synopsis

Declared in <boost/asio/read_at.hpp>

template<
    typename AsyncRandomAccessReadDevice,
    typename MutableBufferSequence,
    boost::asio::completion_token_for<void(boost::system::error_code, size_t)> ReadToken = default_completion_token_t<AsyncRandomAccessReadDevice::executor_type>>
decltype(async_initiate<ReadToken,
      void (boost::system::error_code, std::size_t)>(
        declval<detail::initiate_async_read_at<AsyncRandomAccessReadDevice>>(),
        token, offset, buffers, transfer_all()))
async_read_at(
    AsyncRandomAccessReadDevice& d,
    std::uint64_t offset,
    MutableBufferSequence const& buffers,
    ReadToken&& token = default_completion_token_t<
      typename AsyncRandomAccessReadDevice::executor_type>(),
    int = 0);

Description

This function is used to asynchronously read a certain number of bytes of data from a random access device at the specified offset. It is an initiating function for an asynchronous_operation, and always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

  • The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.

  • An error occurred.

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

void handler(
  // Result of operation.
  const boost::system::error_code& error,

  // Number of bytes copied into the buffers. If an error
  // occurred, this will be the number of bytes successfully
  // transferred prior to the error.
  std::size_t bytes_transferred
);

Regardless of whether the asynchronous operation completes immediately or not, the completion 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 boost::asio::async_immediate().

Completion Signature

void(boost::system::error_code, std::size_t)

Example

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

boost::asio::async_read_at(d, 42, boost::asio::buffer(data, size), handler);

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.

This overload is equivalent to calling: 
boost::asio::async_read_at(
    d, 42, buffers,
    boost::asio::transfer_all(),
    handler);

Per‐Operation Cancellation

This asynchronous operation supports cancellation for the following boost::asio::cancellation_type values:

  • cancellation_type::terminal

  • cancellation_type::partial

if they are also supported by the AsyncRandomAccessReadDevice type's async_read_some_at operation.

Parameters

Name

Description

d

The device from which the data is to be read. The type must support the AsyncRandomAccessReadDevice 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. 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 completion handler is called.

token

The completion_token that will be used to produce a completion handler, which will be called when the read completes. Potential completion tokens include use_future, use_awaitable, yield_context, or a function object with the correct completion signature. The function signature of the completion handler must be:

Created with MrDocs

Edit this Page