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

This is the documentation for an old version of boost. Click here for the latest Boost documentation.
PrevUpHomeNext
basic_timeout_socket::async_read_some

Start an asynchronous read.

Synopsis
template<
    class MutableBufferSequence,
    class ReadHandler>
DEDUCED
async_read_some(
    MutableBufferSequence const& buffers,
    ReadHandler&& handler);
Description

This function is used to asynchronously read data from the stream socket. The function call always returns immediately.

Parameters

Name

Description

buffers

One or more buffers into which the data will be read. 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 handler is called.

handler

The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:

 void handler(
  const boost::system::error_code& error, // Result of operation.
  std::size_t bytes_transferred           // Number of bytes read.
);

Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using boost::asio::io_context::post().


PrevUpHomeNext