...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Read a complete message.
template< class DynamicBuffer> std::size_t read( DynamicBuffer& buffer, error_code& ec);
This function is used to read a complete message. The call blocks until one of the following is true:
error::closed
.
The algorithm, known as a composed operation, is
implemented in terms of calls to the next layer's read_some
and write_some
functions.
Received message data is appended to the buffer. The functions got_binary
and got_text
may be used to query
the stream and determine the type of the last received message. Until
the call returns, the implementation will read incoming control frames
and handle them automatically as follows:
control_callback
will be
invoked for each control frame.
error::closed
will be indicated.
The number of message payload bytes appended to the buffer.
Name |
Description |
---|---|
|
A dynamic buffer to append message data to. |
|
Set to indicate what error occurred, if any. |