...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.
template< class DynamicBuffer> std::size_t read_some( DynamicBuffer& buffer, std::size_t limit, error_code& ec);
This function is used to synchronously read some message data from the stream. The call blocks until one of the following is true:
websocket::closed
.
This operation is implemented in terms of one or more calls to the next
layer's read_some
and
write_some
functions.
Received message data, if any, is appended to the input area of the buffer.
The functions websocket::stream::got_binary
and websocket::stream::got_text
may be used to query
the stream and determine the type of the last received message. The function
websocket::stream::is_message_done
may be called
to determine if the message received by the last read operation is complete.
While this operation is active, the implementation will read incoming control frames and handle them automatically as follows:
websocket::stream::control_callback
will be
invoked for each control frame.
websocket::closed
will be indicated.
The number of message payload bytes appended to the buffer.
Name |
Description |
---|---|
|
A dynamic buffer to hold the message data after any masking or decompression has been applied. |
|
An upper limit on the number of bytes this function will append into the buffer. If this value is zero, then a reasonable size will be chosen automatically. |
|
Set to indicate what error occurred, if any. |