| Home | Libraries | People | FAQ | More

###### websocket::stream::pong (1 of 2 overloads)

Send a websocket pong control frame.

###### Synopsis

    void
    pong(
        ping_data const& payload);

###### Description

This function is used to send a pong frame, which is usually sent automatically in response to a ping frame from the remote peer.

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

- The pong frame is written.
- An error occurs.

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

WebSocket allows pong frames to be sent at any time, without first receiving a ping. An unsolicited pong sent in this fashion may indicate to the remote peer that the connection is still active.

###### Parameters

Name | Description
--- | ---
`payload` | The payload of the pong message, which may be empty.

###### Exceptions

Type | Thrown On
--- | ---
`[link beast.ref.boost__beast__system_error system_error]` | Thrown on failure.