aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/manual')
-rw-r--r--doc/src/manual/cowboy_websocket.asciidoc10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/src/manual/cowboy_websocket.asciidoc b/doc/src/manual/cowboy_websocket.asciidoc
index b728edf..7979b97 100644
--- a/doc/src/manual/cowboy_websocket.asciidoc
+++ b/doc/src/manual/cowboy_websocket.asciidoc
@@ -134,7 +134,8 @@ timeout::
----
opts() :: #{
compress => boolean(),
- idle_timeout => timeout()
+ idle_timeout => timeout(),
+ req_filter => fun((cowboy_req:req()) -> map())
}
----
@@ -162,6 +163,13 @@ idle_timeout (60000)::
connection open without receiving anything from
the client.
+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.
+
== Changelog
* *2.0*: The Req object is no longer passed to Websocket callbacks.