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

PrevUpHomeNext
basic_datagram_socket::async_receive (2 of 2 overloads)

Start an asynchronous receive on a connected socket.

template<
    typename MutableBufferSequence,
    typename ReadToken = DEFAULT>
DEDUCED async_receive(
    const MutableBufferSequence & buffers,
    socket_base::message_flags flags,
    ReadToken && token = DEFAULT);

This function is used to asynchronously receive data from the datagram socket. 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 received. 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.

flags

Flags specifying how the receive call is to be made.

token

The completion token that will be used to produce a completion handler, which will be called when the receive 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 boost::system::error_code& error, // Result of operation.
  std::size_t bytes_transferred // Number of bytes received.
);

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(boost::system::error_code, std::size_t)
Remarks

The async_receive operation can only be used with a connected socket. Use the async_receive_from function to receive data on an unconnected datagram socket.

Per-Operation Cancellation

On POSIX or Windows operating systems, this asynchronous operation supports cancellation for the following cancellation_type values:


PrevUpHomeNext