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.
http::read (4 of 4 overloads)

Read a complete message from a stream.


Defined in header <boost/beast/http/read.hpp>

    class SyncReadStream,
    class DynamicBuffer,
    bool isRequest,
    class Body,
    class Allocator>
    SyncReadStream& stream,
    DynamicBuffer& buffer,
    message< isRequest, Body, basic_fields< Allocator >>& msg,
    error_code& ec);

This function is used to read a complete message from a stream using HTTP/1. The call will block until one of the following conditions is true:

This operation is implemented in terms of one or more calls to the stream's read_some function. The implementation may read additional octets that lie past the end of the message being read. This additional data is stored in the dynamic buffer, which must be retained for subsequent reads.

If the stream returns the error boost::asio::error::eof indicating the end of file during a read, the error returned from this function will be:





The stream from which the data is to be read. The type must support the SyncReadStream concept.


A DynamicBuffer holding additional bytes read by the implementation from the stream. This is both an input and an output parameter; on entry, any data in the dynamic buffer's input sequence will be given to the parser first.


An object in which to store the message contents. This object should not have previous contents, otherwise the behavior is undefined. The type must be MoveAssignable and MoveConstructible.


Set to the error, if any occurred.

Return Value

The number of bytes transferred to the parser.

Convenience header <boost/beast/http.hpp>