diff options
Diffstat (limited to 'doc/src/manual/cowboy_websocket.asciidoc')
| -rw-r--r-- | doc/src/manual/cowboy_websocket.asciidoc | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_websocket.asciidoc b/doc/src/manual/cowboy_websocket.asciidoc index a11ca18..5b1558c 100644 --- a/doc/src/manual/cowboy_websocket.asciidoc +++ b/doc/src/manual/cowboy_websocket.asciidoc @@ -198,6 +198,7 @@ Cowboy does it automatically for you. [source,erlang] ---- opts() :: #{ + active_n => pos_integer(), compress => boolean(), deflate_opts => cow_ws:deflate_opts() idle_timeout => timeout(), @@ -221,6 +222,16 @@ init(Req, State) -> The default value is given next to the option name: +active_n (100):: + +The number of packets Cowboy will request from the socket at once. +This can be used to tweak the performance of the server. Higher +values reduce the number of times Cowboy need to request more +packets from the port driver at the expense of potentially +higher memory being used. ++ +This option does not apply to Websocket over HTTP/2. + compress (false):: Whether to enable the Websocket frame compression @@ -274,6 +285,7 @@ normal circumstances if necessary. == Changelog +* *2.8*: The `active_n` option was added. * *2.7*: The commands based interface has been documented. The old interface is now deprecated. * *2.7*: The command `shutdown_reason` was introduced. |