...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> void-or-deduced async_receive( const MutableBufferSequence & buffers, ReadHandler handler);
This function is used to asynchronously receive data from the stream 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.
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.
Invocation of the handler will be performed in a manner equivalent
The receive operation may not receive 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 received before the asynchronous
To receive into a single data buffer use the
buffer function as follows:
socket.async_receive(boost::asio::buffer(data, size), handler);
documentation for information on receiving into multiple buffers in one
go, and how to use it with arrays, boost::array or std::vector.