boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-08-01 05:44:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for websocket::permessage_deflate

Browse Source 
Resolves #962
This commit is contained in:
Mohammad Nejati
2024-02-14 07:34:23 +00:00
committed by Mohammad Nejati
parent 7d4da621ac
commit 40c22cbfa7
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/boost/beast/websocket/option.hpp
View File

@@ -21,8 +21,13 @@ namespace websocket {
These settings control the permessage-deflate extension, These settings control the permessage-deflate extension,
which allows messages to be compressed. which allows messages to be compressed.
@note Objects of this type are used with @note
@ref beast::websocket::stream::set_option.
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 struct permessage_deflate
{ {

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

@@ -398,6 +398,11 @@ public:
@throws invalid_argument if `deflateSupported == false`, and either @throws invalid_argument if `deflateSupported == false`, and either
`client_enable` or `server_enable` is `true`. `client_enable` or `server_enable` is `true`.
@note
These settings should be configured before performing the WebSocket
handshake.
*/ */
void void
set_option(permessage_deflate const& o); set_option(permessage_deflate const& o);