| Home | Libraries | People | FAQ | More

###### websocket::stream::ping (2 of 2 overloads)

Send a WebSocket ping frame.

Synopsis

    void
    ping(
        ping_data const& payload,
        error_code& ec);

Description

This function is used to synchronously send a ping frame on the stream. The call blocks until one of the following is true:

- The ping frame finishes sending.
- An error occurs on the stream.

This function is implemented in terms of one or more calls to the next layer's `write_some` functions.

Parameters

Name | Description
--- | ---
`payload` | The payload of the ping message, which may be empty.
`ec` | Set to indicate what error occurred, if any.