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

This is the documentation for a snapshot of the master branch, built from commit c6a8213e9b.
PrevUpHomeNext
websocket::stream::ping (1 of 2 overloads)

Send a websocket ping control frame.

Synopsis
void
ping(
    ping_data const& payload);
Description

This function is used to send a ping frame, which usually elicits an automatic pong control frame response from the peer.

The call blocks until one of the following conditions is true:

The algorithm, known as a composed operation, is implemented in terms of calls to the next layer's write_some function.

Parameters

Name

Description

payload

The payload of the ping message, which may be empty.

Exceptions

Type

Thrown On

system_error

Thrown on failure.


PrevUpHomeNext