feedc0de/boost_beast
1
0
Fork 0
forked from boostorg/beast
Code Pull Requests Activity

Fix websocket stream read documentation

Browse Source
This commit is contained in:
Vinnie Falco
2017-01-07 09:38:21 -05:00
parent c6dae58364
commit 64e0bb15ad
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/beast/websocket/stream.hpp
View File

@@ -1183,10 +1183,10 @@ public:
hold all the message payload bytes (which may be zero in length). hold all the message payload bytes (which may be zero in length).
Control frames encountered while reading frame or message data Control frames encountered while reading frame or message data
are handled automatically. Pings are replied to, pongs cause are handled automatically. Pings are replied to automatically,
an outstanding call to `async_ping` to complete, and close pongs are routed to the pong callback if the option is set,
frames initiate the WebSocket close procedure. When a close and close frames initiate the WebSocket close procedure. When a
frame is received, this call will eventually return close frame is received, this call will eventually return
@ref error::closed. Because of the need to handle control @ref error::closed. Because of the need to handle control
frames, these read operations can cause writes to take place. frames, these read operations can cause writes to take place.
Despite this, calls to `async_read` and `async_read_frame` Despite this, calls to `async_read` and `async_read_frame`