| Home | Libraries | People | FAQ | More

###### websocket::stream::read (2 of 2 overloads)

Read a complete message.

<h7> Synopsis </h7>

    template<
        class DynamicBuffer>
    std::size_t
    read(
        DynamicBuffer& buffer,
        error_code& ec);

<h7> Description </h7>

This function is used to read a complete message. The call blocks until one of the following is true:

- A complete message is received.
- A close frame is received. In this case the error indicated by the function will be `websocket::closed`.
- An error occurs.

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 `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. Until the call returns, the implementation will read incoming control frames and handle them automatically as follows:

- The `websocket::stream::control_callback` will be invoked for each control frame.
- For each received ping frame, a pong frame will be automatically sent.
- If a close frame is received, the WebSocket closing handshake is performed. In this case, when the function returns, the error `websocket::closed` will be indicated.

<h7> Return Value </h7>

The number of message payload bytes appended to the buffer.

<h7> Parameters </h7>

Name | Description
--- | ---
`buffer` | A dynamic buffer to append message data to.
`ec` | Set to indicate what error occurred, if any.