User avatar admin

String added in the repository
Ping, pong, and close messages are control frames which may be sent at any time by either peer on an established WebSocket connection. They are sent using the functions [link beast.ref.boost__beast__websocket__stream.ping `ping`], [link beast.ref.boost__beast__websocket__stream.pong `pong`]. and [link beast.ref.boost__beast__websocket__stream.close `close`]. To be notified of control frames, callers may register a ['control callback] using [link beast.ref.boost__beast__websocket__stream.control_callback `control_callback`]. The object provided with this option should be callable with the following signature:
Ping, pong, and close messages are control frames which may be sent at any time by either peer on an established WebSocket connection. They are sent using the functions [link beast.ref.boost__beast__websocket__stream.ping `ping`], [link beast.ref.boost__beast__websocket__stream.pong `pong`]. and [link beast.ref.boost__beast__websocket__stream.close `close`]. To be notified of control frames, callers may register a ['control callback] using [link beast.ref.boost__beast__websocket__stream.control_callback `control_callback`]. The object provided with this option should be callable with the following signature:
06/05/2026
User avatar admin

String added in the repository
Control Callback
Control Callback
06/05/2026
User avatar admin

String added in the repository
A consequence of this automatic behavior is that caller-initiated read operations can cause socket writes. However, these writes will not compete with caller-initiated write operations. For the purposes of correctness with respect to the stream invariants, caller-initiated read operations still only count as a read. This means that callers can have a simultaneously active read, write, and ping/pong operation in progress, while the implementation also automatically handles control frames.
A consequence of this automatic behavior is that caller-initiated read operations can cause socket writes. However, these writes will not compete with caller-initiated write operations. For the purposes of correctness with respect to the stream invariants, caller-initiated read operations still only count as a read. This means that callers can have a simultaneously active read, write, and ping/pong operation in progress, while the implementation also automatically handles control frames.
06/05/2026
User avatar admin

String added in the repository
During read operations, Beast automatically reads and processes control frames. If a control callback is registered, the callback is notified of the incoming control frame. The implementation will respond to pings automatically. The receipt of a close frame initiates the WebSocket close procedure, eventually resulting in the error code [link beast.ref.boost__beast__websocket__error `error::closed`] being delivered to the caller in a subsequent read operation, assuming no other error takes place.
During read operations, Beast automatically reads and processes control frames. If a control callback is registered, the callback is notified of the incoming control frame. The implementation will respond to pings automatically. The receipt of a close frame initiates the WebSocket close procedure, eventually resulting in the error code [link beast.ref.boost__beast__websocket__error `error::closed`] being delivered to the caller in a subsequent read operation, assuming no other error takes place.
06/05/2026
User avatar admin

String added in the repository
A sent ping indicates a request that the sender wants to receive a pong. A pong is a response to a ping. Pongs may be sent unsolicited, at any time. One use for an unsolicited pong is to inform the remote peer that the session is still active after a long period of inactivity. A close frame indicates that the remote peer wishes to close the WebSocket connection. The connection is considered gracefully closed when each side has sent and received a close frame.
A sent ping indicates a request that the sender wants to receive a pong. A pong is a response to a ping. Pongs may be sent unsolicited, at any time. One use for an unsolicited pong is to inform the remote peer that the session is still active after a long period of inactivity. A close frame indicates that the remote peer wishes to close the WebSocket connection. The connection is considered gracefully closed when each side has sent and received a close frame.
06/05/2026
User avatar admin

String added in the repository
Control frames are small (less than 128 bytes) messages entirely contained in an individual WebSocket frame. They may be sent at any time by either peer on an established connection, and can appear in between continuation frames for a message. There are three types of control frames: ping, pong, and close.
Control frames are small (less than 128 bytes) messages entirely contained in an individual WebSocket frame. They may be sent at any time by either peer on an established connection, and can appear in between continuation frames for a message. There are three types of control frames: ping, pong, and close.
06/05/2026
User avatar admin

String added in the repository
Control Frames
Control Frames
06/05/2026
User avatar admin

Resource updated
Parsing of the “doc/qbk/06_websocket/04_messages.qbk” file was enforced. 06/05/2026
User avatar admin

Resource updated
File “doc/qbk/06_websocket/04_messages.qbk” was added. 06/05/2026
User avatar admin

String added in the repository
For these cases, the partial data oriented interface may be used. This example reads and echoes a complete message using this interface:
For these cases, the partial data oriented interface may be used. This example reads and echoes a complete message using this interface:
06/05/2026
User avatar admin

String added in the repository
* Streaming multimedia to an endpoint.
* Sending a message that does not fit in memory at once.
* Providing incremental results as they become available.
* Streaming multimedia to an endpoint.
* Sending a message that does not fit in memory at once.
* Providing incremental results as they become available.
06/05/2026
User avatar admin

String added in the repository
Some use-cases make it impractical or impossible to buffer the entire message ahead of time:
Some use-cases make it impractical or impossible to buffer the entire message ahead of time:
06/05/2026
User avatar admin

String added in the repository
Frames
Frames
06/05/2026
User avatar admin

String added in the repository
After the WebSocket handshake is accomplished, callers may send and receive messages using the message oriented interface. This interface requires that all of the buffers representing the message are known ahead of time:
After the WebSocket handshake is accomplished, callers may send and receive messages using the message oriented interface. This interface requires that all of the buffers representing the message are known ahead of time:
06/05/2026
User avatar admin

String added in the repository
Read part of a message into a __MutableBufferSequence__.
Read part of a message into a __MutableBufferSequence__.
06/05/2026
User avatar admin

String added in the repository
[link beast.ref.boost__beast__websocket__stream.read_some.overload4 `read_some`], [link beast.ref.boost__beast__websocket__stream.async_read_some.overload2 `async_read_some`]
[link beast.ref.boost__beast__websocket__stream.read_some.overload4 `read_some`], [link beast.ref.boost__beast__websocket__stream.async_read_some.overload2 `async_read_some`]
06/05/2026
User avatar admin

String added in the repository
Read part of a message into a __DynamicBuffer__.
Read part of a message into a __DynamicBuffer__.
06/05/2026
User avatar admin

String added in the repository
[link beast.ref.boost__beast__websocket__stream.read_some.overload2 `read_some`], [link beast.ref.boost__beast__websocket__stream.async_read_some.overload1 `async_read_some`]
[link beast.ref.boost__beast__websocket__stream.read_some.overload2 `read_some`], [link beast.ref.boost__beast__websocket__stream.async_read_some.overload1 `async_read_some`]
06/05/2026
User avatar admin

String added in the repository
Read a complete message into a __DynamicBuffer__.
Read a complete message into a __DynamicBuffer__.
06/05/2026
User avatar admin

String added in the repository
[link beast.ref.boost__beast__websocket__stream.read.overload2 `read`], [link beast.ref.boost__beast__websocket__stream.async_read `async_read`]
[link beast.ref.boost__beast__websocket__stream.read.overload2 `read`], [link beast.ref.boost__beast__websocket__stream.async_read `async_read`]
06/05/2026

Search