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

Click here to view the latest version of this page.
PrevUpHomeNext
basic_stream_socket::receive (2 of 3 overloads)

Receive some data on the socket.

template<
    typename MutableBufferSequence>
std::size_t receive(
    const MutableBufferSequence & buffers,
    socket_base::message_flags flags);

This function is used to receive data on the stream socket. The function call will block until one or more bytes of data has been received successfully, or until an error occurs.

Parameters

buffers

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

flags

Flags specifying how the receive call is to be made.

Return Value

The number of bytes received.

Exceptions

boost::system::system_error

Thrown on failure. An error code of boost::asio::error::eof indicates that the connection was closed by the peer.

Remarks

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

Example

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

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

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.


PrevUpHomeNext