Update documentation for websocket::permessage_deflate

Resolves boostorg#962
xim · Feb 14, 2024 · 40c22cb · 40c22cb
1 parent 7d4da62
commit 40c22cb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/include/boost/beast/websocket/option.hpp b/include/boost/beast/websocket/option.hpp
@@ -21,8 +21,13 @@ namespace websocket {
     These settings control the permessage-deflate extension,
     which allows messages to be compressed.
 
-    @note Objects of this type are used with
-          @ref beast::websocket::stream::set_option.
+    @note
+
+    These settings should be configured before performing the WebSocket
+    handshake.
+
+    Objects of this type are used with
+    @ref beast::websocket::stream::set_option.
 */
 struct permessage_deflate
 {

diff --git a/include/boost/beast/websocket/stream.hpp b/include/boost/beast/websocket/stream.hpp
@@ -398,6 +398,11 @@ class stream
 
         @throws invalid_argument if `deflateSupported == false`, and either
         `client_enable` or `server_enable` is `true`.
+
+        @note
+
+        These settings should be configured before performing the WebSocket
+        handshake.
     */
     void
     set_option(permessage_deflate const& o);