umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Code Issues Wiki Activity

Add deflate options for Websocket compression

Browse source 
They allow the server to configure what it is willing to accept
for both the negotiated configuration (takeover and window bits)
and the other zlib options (level, mem_level and strategy).

This can be used to reduce the memory and/or CPU footprint of
the compressed data, which comes with a cost in compression ratio.
This commit is contained in:
Loïc Hoguin 2018-11-12 18:12:44 +01:00
parent fe1ee080de
commit 8164b50453
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
4 changed files with 220 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

46
doc/src/manual/cowboy_websocket.asciidoc
View file

@ -152,6 +152,7 @@ Cowboy does it automatically for you.
----
opts() :: #{
compress => boolean(),
deflate_opts => cow_ws:deflate_opts()
idle_timeout => timeout(),
max_frame_size => non_neg_integer() | infinity,
req_filter => fun((cowboy_req:req()) -> map())
@ -173,31 +174,44 @@ init(Req, State) ->
The default value is given next to the option name:
compress (false)::
Whether to enable the Websocket frame compression
extension. Frames will only be compressed for the
clients that support this extension.
Whether to enable the Websocket frame compression
extension. Frames will only be compressed for the
clients that support this extension.
deflate_opts (#{})::
Configuration for the permessage-deflate Websocket
extension. Allows configuring both the negotiated
options and the zlib compression options. The
defaults optimize the compression at the expense
of some memory and CPU.
idle_timeout (60000)::
Time in milliseconds that Cowboy will keep the
connection open without receiving anything from
the client.
Time in milliseconds that Cowboy will keep the
connection open without receiving anything from
the client.
max_frame_size (infinity)::
Maximum frame size allowed by this Websocket
handler. Cowboy will close the connection when
a client attempts to send a frame that goes over
this limit. For fragmented frames this applies
to the size of the reconstituted frame.
Maximum frame size allowed by this Websocket
handler. Cowboy will close the connection when
a client attempts to send a frame that goes over
this limit. For fragmented frames this applies
to the size of the reconstituted frame.
req_filter::
A function applied to the Req to compact it and
only keep required information. The Req is only
given back in the `terminate/3` callback. By default
it keeps the method, version, URI components and peer
information.
A function applied to the Req to compact it and
only keep required information. The Req is only
given back in the `terminate/3` callback. By default
it keeps the method, version, URI components and peer
information.
== Changelog
* *2.6*: Deflate options can now be configured via `deflate_opts`.
* *2.0*: The Req object is no longer passed to Websocket callbacks.
* *2.0*: The callback `websocket_terminate/3` was removed in favor of `terminate/3`.
* *1.0*: Protocol introduced.