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
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
Read part of a message from a stream using a parser.
Defined in header <boost/beast/http/read.hpp>
template< class SyncReadStream, class DynamicBuffer, bool isRequest> std::size_t read_some( SyncReadStream& stream, DynamicBuffer& buffer, basic_parser< isRequest >& parser, error_code& ec);
This function is used to read part of a message from a stream into an instance
of basic_parser. The call will block
until one of the following conditions is true:
basic_parser::put with a non-empty buffer
sequence is successful.
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_stream
if no bytes were parsed, or
error::partial_message
if any bytes were parsed but the message was incomplete, otherwise:
error::end_of_stream
|
Name |
Description |
|---|---|
|
|
The stream from which the data is to be read. The type must support 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 parser to use. |
|
|
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.