Boost
C++ Libraries
...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Boost
C++ Libraries
...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Set a callback to be invoked on each incoming control frame.
void control_callback( std::function< void(frame_type, string_view)> cb);
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. For close frames, the close reason code may be obtained by
calling the function reason.
|
Name |
Description |
|---|---|
|
|
The function object to call, which must be invocable with this equivalent signature: void callback( frame_type kind, // The type of frame string_view payload // The payload in the frame );
The implementation type-erases the callback which may require
a dynamic allocation. To prevent the possibility of a dynamic
allocation, use |
Incoming ping and close frames are automatically handled. Pings are responded to with pongs, and a close frame is responded to with a close frame leading to the closure of the stream. It is not necessary to manually send pings, pongs, or close frames from inside the control callback. Attempting to manually send a close frame from inside the control callback after receiving a close frame will result in undefined behavior.