Tidy up some WebSocket javadocs

This commit is contained in:
Vinnie Falco committed 2017-07-20 08:12:14 -07:00
1 parent a983bb4fe7
commit 5bbbb1fb30
3 files changed
+92 -61

No files matched your search

+8 -7
View File
@@ -236,14 +236,15 @@ struct permessage_deflate
/** Ping callback option.
Sets the callback to be invoked whenever a ping or pong is
received during a call to
@ref beast::websocket::stream::read,
@ref beast::websocket::stream::read_frame,
@ref beast::websocket::stream::async_read, or
@ref beast::websocket::stream::async_read_frame.
received during a call to one of the following functions:
Unlike completion handlers, the callback will be invoked for
each received ping and pong pong during a call to any
@li @ref beast::websocket::stream::read
@li @ref beast::websocket::stream::read_frame
@li @ref beast::websocket::stream::async_read
@li @ref beast::websocket::stream::async_read_frame
Unlike completion handlers, the callback will be invoked
for each received ping and pong during a call to any
synchronous or asynchronous read function. The operation is
passive, with no associated error code, and triggered by reads.