diff options
| author | Loïc Hoguin <[email protected]> | 2025-01-16 14:40:37 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2025-01-16 14:47:20 +0100 |
| commit | 81de580aeec405481cacb618a131fa895605004b (patch) | |
| tree | 52f789b64dea14a10fa0e4b1cdedc989fa443f56 /doc/src | |
| parent | 818b448ae9eab17aadc8ea2bacaa82948a2e9b56 (diff) | |
| download | cowboy-81de580aeec405481cacb618a131fa895605004b.tar.gz cowboy-81de580aeec405481cacb618a131fa895605004b.tar.bz2 cowboy-81de580aeec405481cacb618a131fa895605004b.zip | |
Websocket: Allow setting the max_frame_size option dynamically
This can be used to limit the maximum frame size before
some authentication or other validation is completed.
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/manual/cowboy_websocket.asciidoc | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/src/manual/cowboy_websocket.asciidoc b/doc/src/manual/cowboy_websocket.asciidoc index 6d822d9..e152182 100644 --- a/doc/src/manual/cowboy_websocket.asciidoc +++ b/doc/src/manual/cowboy_websocket.asciidoc @@ -138,7 +138,9 @@ commands() :: [Command] Command :: {active, boolean()} | {deflate, boolean()} - | {set_options, #{idle_timeout => timeout()}} + | {set_options, #{ + idle_timeout => timeout(), + max_frame_size => non_neg_integer() | infinity}} | {shutdown_reason, any()} | Frame :: cow_ws:frame() ---- @@ -159,8 +161,8 @@ effect on connections that did not negotiate compression. set_options:: -Set Websocket options. Currently only the option `idle_timeout` -may be updated from a Websocket handler. +Set Websocket options. Currently only the options `idle_timeout` +and `max_frame_size` may be updated from a Websocket handler. shutdown_reason:: @@ -285,6 +287,7 @@ normal circumstances if necessary. == Changelog +* *2.13*: The `max_frame_size` option can now be set dynamically. * *2.11*: Websocket over HTTP/2 is now considered stable. * *2.11*: HTTP/1.1 Websocket no longer traps exits by default. * *2.8*: The `active_n` option was added. |