boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-29 20:37:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve websocket::stream::control_callback javadoc

Browse Source 
fix #1053
This commit is contained in:
Vinnie Falco
2018-03-01 11:31:41 -08:00
parent 726118468b
commit ebd036a300
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -1,6 +1,7 @@
Version 162:
* Add asio_handler_invoke overloads for stream algorithms
* Improve websocket::stream::control_callback javadoc
--------------------------------------------------------------------------------

12
include/boost/beast/websocket/stream.hpp
View File

@ -578,10 +578,14 @@ public:
an asynchronous operation, the callback will be invoked using
the same method as that used to invoke the final handler.
@note It is not necessary to send a close frame upon receipt
of a close frame. The implementation does this automatically.
Attempting to send a close frame after a close frame is
received will result in undefined behavior.
@note Incoming ping and close frames are automatically
handled. Pings are responded to with pongs, and a close frame
is responded to with a close frame leading to the closure of
the stream. It is not necessary to manually send pings, pongs,
or close frames from inside the control callback.
Attempting to manually send a close frame from inside the
control callback after receiving a close frame will result
in undefined behavior.
*/
void
control_callback(std::function<void(frame_type, string_view)> cb)