Update documentation for websocket::permessage_deflate

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

View File

@ -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
{

View File

@ -398,6 +398,11 @@ public:
@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);