aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
diff options
context:
space:
mode:
authorKirill Kinduk <[email protected]>2017-08-25 12:08:26 +0300
committerLoïc Hoguin <[email protected]>2018-03-28 16:58:02 +0200
commit4c34774b7eb787e37892399f2daddba68ec277e3 (patch)
tree8640e0950bb363acde6f87f1f7a2977d3185c852 /doc/src/guide
parent288deb5b88dd8e0aae57c9858d16c19ca9f186f9 (diff)
downloadcowboy-4c34774b7eb787e37892399f2daddba68ec277e3.tar.gz
cowboy-4c34774b7eb787e37892399f2daddba68ec277e3.tar.bz2
cowboy-4c34774b7eb787e37892399f2daddba68ec277e3.zip
Add max_frame_size option for websocket handlers
Option allows to limit a frame by size before decoding its payload. LH: I have added a test for when the limit is reached on a nofin fragmented frame (the last commit addressed that case but it had no test). I have fixed formatting and other, and changed the default value to infinity since it might otherwise be incompatible with existing code. I also added documentation and a bunch of other minor changes.
Diffstat (limited to 'doc/src/guide')
-rw-r--r--doc/src/guide/ws_handlers.asciidoc16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/src/guide/ws_handlers.asciidoc b/doc/src/guide/ws_handlers.asciidoc
index c944606..71165af 100644
--- a/doc/src/guide/ws_handlers.asciidoc
+++ b/doc/src/guide/ws_handlers.asciidoc
@@ -225,6 +225,22 @@ init(Req, State) ->
This value cannot be changed once it is set. It defaults to
`60000`.
+=== Limiting frame sizes
+
+Cowboy accepts frames of any size by default. You should
+limit the size depending on what your handler may handle.
+You can do this via the `init/2` callback:
+
+[source,erlang]
+----
+init(Req, State) ->
+ {cowboy_websocket, Req, State, #{
+ max_frame_size => 8000000}}.
+----
+
+The lack of limit is historical. A future version of
+Cowboy will have a more reasonable default.
+
=== Saving memory
The Websocket connection process can be set to hibernate