From 64e0bb15ad4eaf154188816712316fee4da2818b Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Sat, 7 Jan 2017 09:38:21 -0500 Subject: [PATCH] Fix websocket stream read documentation --- include/beast/websocket/stream.hpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/beast/websocket/stream.hpp b/include/beast/websocket/stream.hpp index 23c9e344..d5f26fb8 100644 --- a/include/beast/websocket/stream.hpp +++ b/include/beast/websocket/stream.hpp @@ -1183,10 +1183,10 @@ public: hold all the message payload bytes (which may be zero in length). Control frames encountered while reading frame or message data - are handled automatically. Pings are replied to, pongs cause - an outstanding call to `async_ping` to complete, and close - frames initiate the WebSocket close procedure. When a close - frame is received, this call will eventually return + are handled automatically. Pings are replied to automatically, + pongs are routed to the pong callback if the option is set, + and close frames initiate the WebSocket close procedure. When a + close frame is received, this call will eventually return @ref error::closed. Because of the need to handle control frames, these read operations can cause writes to take place. Despite this, calls to `async_read` and `async_read_frame`