Beast Logo

PrevUpHomeNext

websocket::stream::async_read_frame

Start an asynchronous operation to read a message frame from the stream.

template<
    class DynamicBuffer,
    class ReadHandler>
void-or-deduced
async_read_frame(
    frame_info& fi,
    DynamicBuffer& dynabuf,
    ReadHandler&& handler);

This function is used to asynchronously read a single message frame from the websocket. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

This operation is implemented in terms of one or more calls to the next layer's async_read_some and async_write_some functions, and is known as a composed operation. The program must ensure that the stream performs no other reads until this operation completes.

Upon a successful completion, fi is filled out to reflect the message payload contents. op is set to binary or text, and the fin flag indicates if all the message data has been read in. To read the entire message, callers should keep calling read_frame until fi.fin == true. A message with no payload will have fi.fin == true, and zero bytes placed into the stream buffer.

During reads, the implementation handles control frames as follows:

Because of the need to handle control frames, read operations can cause writes to take place. These writes are managed transparently; callers can still have one active asynchronous read and asynchronous write operation pending simultaneously (a user initiated call to async_close counts as a write).

Parameters

fi

An object to store metadata about the message. This object must remain valid until the handler is called.

dynabuf

A dynamic buffer to hold the message data after any masking or decompression has been applied. This object must remain valid until the handler is called.

handler

The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:

void handler(
    error_code const& error     // Result of operation
);

Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using boost::asio::io_service::post().


PrevUpHomeNext