http::read (3 of 4 overloads)

Read a complete message from a stream.

Synopsis

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

template<
    class SyncReadStream,
    class DynamicBuffer,
    bool isRequest,
    class Body,
    class Allocator>
std::size_t
read(
    SyncReadStream& stream,
    DynamicBuffer& buffer,
    message< isRequest, Body, basic_fields< Allocator >>& msg);

Description

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:

The entire message is read.
An error occurs.

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:

http::end_of_stream if no octets were parsed, or
http::partial_message if any octets were parsed but the message was incomplete, otherwise:
A successful result. A subsequent attempt to read will return http::end_of_stream

Parameters

Name	Description
`stream`	The stream from which the data is to be read. The type must support the SyncReadStream concept.
`buffer`	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.
`msg`	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.

Return Value

The number of bytes transferred to the parser.

Exceptions

Type	Thrown On
`system_error`	Thrown on failure.

Convenience header <boost/beast/http.hpp>