...one of the most highly
regarded and expertly designed C++ library projects in the
world. — Herb Sutter and Andrei
Start an asynchronous receive.
template< typename MutableBufferSequence, typename ReadHandler> DEDUCED async_receive( const MutableBufferSequence & buffers, socket_base::message_flags & out_flags, ReadHandler && handler);
This function is used to asynchronously receive data from the sequenced packet socket. The function call always returns immediately.
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 handler is called.
Once the asynchronous operation completes, contains flags associated
with the received data. For example, if the
bit is set then the received data marks the end of a record. The
caller must guarantee that the referenced variable remains valid
until the handler is called.
The handler to be called when the receive 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 received. );
Regardless of whether the asynchronous operation completes immediately
or not, the 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
To receive into a single data buffer use the
function as follows:
socket.async_receive(boost::asio::buffer(data, size), out_flags, handler);
documentation for information on receiving into multiple buffers in one
go, and how to use it with arrays, boost::array or std::vector.