GitHub

PerMessageDeflate

API reference for PerMessageDeflate.

ws's perMessageDeflate server options. None takes the client's offer as it is; server_no_context_takeover=True / client_no_context_takeover=True ask for it, False refuses offers that ask for it; a window size (8 to 15) caps the offer, False refuses a server_max_window_bits offer (and drops client_max_window_bits). Messages shorter than threshold bytes go uncompressed.

Attributes

AttributeTypeDescription
server_no_context_takeoverbool | None = None
client_no_context_takeoverbool | None = None
server_max_window_bitsint | Literal[False] | None = None
client_max_window_bitsint | Literal[False] | None = None
thresholdint = 1024

Functions

__init__

__init__(*, server_no_context_takeover=None, client_no_context_takeover=None, server_max_window_bits=None, client_max_window_bits=None, threshold=1024) -> None
ParameterTypeDescription
server_no_context_takeoverbool | None = None
client_no_context_takeoverbool | None = None
server_max_window_bitsint | Literal[False] | None = None
client_max_window_bitsint | Literal[False] | None = None
thresholdint = 1024