Boost C++ Libraries 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 to view this page for the latest version.
basic_datagram_socket::receive (1 of 3 overloads)

Receive some data on a connected socket.

    typename MutableBufferSequence>
std::size_t receive(
    const MutableBufferSequence & buffers);

This function is used to receive data on the datagram socket. The function call will block until data has been received successfully or an error occurs.



One or more buffers into which the data will be received.

Return Value

The number of bytes received.



Thrown on failure.


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


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

socket.receive(boost::asio::buffer(data, size));

See the buffer documentation for information on receiving into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.