basic_readable_pipe::async_read

basic_readable_pipe::async_read_some

Start an asynchronous read.

template<
    typename MutableBufferSequence,
    typename ReadToken = default_completion_token_t<executor_type>>
DEDUCED async_read_some(
    const MutableBufferSequence & buffers,
    ReadToken && token = default_completion_token_t< executor_type >());

This function is used to asynchronously read data from the pipe. It is an initiating function for an asynchronous operation, and always returns immediately.

Parameters

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 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:

void handler(
  const asio::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 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 post.

Completion Signature

void(asio::error_code, std::size_t)

Remarks

The read operation may not read all of the requested number of bytes. Consider using the async_read function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.

Example

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

basic_readable_pipe.async_read_some(
    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.