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_some (2 of 2 overloads)

Read part of a message from a stream using a parser.


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

    class SyncReadStream,
    class DynamicBuffer,
    bool isRequest>
    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:

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:





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.

Return Value

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.