...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Start an asynchronous operation to send a WebSocket ping frame.
template< class WriteHandler> DEDUCED async_ping( ping_data const& payload, WriteHandler&& handler);
This function is used to asynchronously send a ping frame to the stream. The function call always returns immediately. The asynchronous operation will continue until one of the following is true:
This operation is implemented in terms of one or more calls to the next
layer's async_write_some
functions, and is known as a composed operation. The
program must ensure that the stream performs no other writes until this
operation completes.
If a close frame is sent or received before the ping frame is sent, the
completion handler will be called with the error set to boost::asio::error::operation_aborted
.
Name |
Description |
---|---|
|
The payload of the ping message, which may be empty. |
|
Invoked when the operation completes. The handler may be moved or copied as needed. The function signature of the handler must be: void handler( error_code const& ec // Result of operation );
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
Invocation of the handler will be performed in a manner equivalent
to using |