...one of the most highly
regarded and expertly designed C++ library projects in the
world. — Herb Sutter and Andrei
Read a complete message from a stream.
Defined in header
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, error_code& ec);
This function is used to read a complete message from a stream into an
message. 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 bytes from the stream that lie past
the end of the message being read. These additional bytes are stored in
the dynamic buffer, which must be preserved for subsequent reads. If the
end of file error is received while reading from the stream, then the error
returned from this function will be:
error::end_of_streamif no bytes were parsed, or
error::partial_messageif any bytes were parsed but the message was incomplete, otherwise:
The stream from which the data is to be read. The type must meet the SyncReadStream requirements.
Storage for additional bytes read by the implementation from the stream. This is both an input and an output parameter; on entry, the parser will be presented with any remaining data in the dynamic buffer's readable bytes sequence first. The type must meet the DynamicBuffer requirements.
The container in which to store the message contents. This message container should not have previous contents, otherwise the behavior is undefined. The type must be meet the MoveAssignable and MoveConstructible requirements.
Set to the error, if any occurred.
The number of bytes transferred from the stream.
The function returns the total number of bytes transferred from the stream.
This may be zero for the case where there is sufficient pre-existing message
data in the dynamic buffer. The implementation will call
basic_parser::eager with the value
true on the parser passed in.