From a7927988ea12dcd1698413207edc129d6da93fb4 Mon Sep 17 00:00:00 2001 From: Mohammad Date: Wed, 25 Oct 2023 09:26:42 +0000 Subject: [PATCH] Update documentation for websocket::stream::async_write_some Closes #2755 --- include/boost/beast/websocket/stream.hpp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/boost/beast/websocket/stream.hpp b/include/boost/beast/websocket/stream.hpp index 2f7fd6f5..0595851f 100644 --- a/include/boost/beast/websocket/stream.hpp +++ b/include/boost/beast/websocket/stream.hpp @@ -2683,6 +2683,10 @@ public: the @ref binary (or @ref text) option. The actual payload sent may be transformed as per the WebSocket protocol settings. + This function always writes a complete WebSocket frame (not WebSocket + message) upon successful completion, so it is well defined to perform + ping, pong, and close operations after this operation completes. + @param fin `true` if this is the last part of the message. @param buffers The buffers containing the message part to send. @@ -2720,6 +2724,10 @@ public: the @ref binary (or @ref text) option. The actual payload sent may be transformed as per the WebSocket protocol settings. + This function always writes a complete WebSocket frame (not WebSocket + message) upon successful completion, so it is well defined to perform + ping, pong, and close operations in parallel to this operation. + @param fin `true` if this is the last part of the message. @param buffers The buffers containing the message part to send.