| Home | Libraries | People | FAQ | More

#### websocket::permessage_deflate

permessage-deflate extension options.

##### Synopsis

Defined in header `<boost/beast/websocket/option.hpp>`

    struct permessage_deflate

##### Data Members

Name | Description
--- | ---
client_enable | `true` to offer the extension in the client role
client_max_window_bits | Maximum client window bits to offer.
client_no_context_takeover | `true` if client_no_context_takeover desired
compLevel | Deflate compression level 0..9.
memLevel | Deflate memory level, 1..9.
msg_size_threshold | The minimum size a message should have to be compressed.
server_enable | `true` to offer the extension in the server role
server_max_window_bits | Maximum server window bits to offer.
server_no_context_takeover | `true` if server_no_context_takeover desired

##### Description

These settings control the permessage-deflate extension, which allows messages to be compressed.

##### Remarks

These settings should be configured before performing the WebSocket handshake.

Objects of this type are used with `beast::websocket::stream::set_option`.