Beast Logo

PrevUpHomeNext
websocket::stream::control_callback

Set the control frame callback.

Synopsis
void
control_callback(
    std::function< void(frame_type, string_view)> cb);
Description

Sets the callback to be invoked whenever a ping, pong, or close control frame is received during a call to one of the following functions:

Unlike completion handlers, the callback will be invoked for each control frame during a call to any synchronous or asynchronous read function. The operation is passive, with no associated error code, and triggered by reads.

The signature of the callback must be:

void
callback(
    frame_type kind,       // The type of frame
    string_view payload    // The payload in the frame
);

For close frames, the close reason code may be obtained by calling the function websocket::stream::reason.

If the read operation which receives the control frame is an asynchronous operation, the callback will be invoked using the same method as that used to invoke the final handler.

Remarks

It is not necessary to send a close frame upon receipt of a close frame. The implementation does this automatically. Attempting to send a close frame after a close frame is received will result in undefined behavior.

Parameters

Name

Description

cb

The callback to set.


PrevUpHomeNext