aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_stream.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-10-07 12:04:39 +0200
committerLoïc Hoguin <[email protected]>2019-10-07 12:07:23 +0200
commitfad0ac8fb68833e8b7b0895eb1b96bb068961917 (patch)
treed066a4a164e321ba4a862eef6ecdd7be44246634 /doc/src/manual/cowboy_stream.asciidoc
parente25fb19bab02ba7fee68d5188d340311fffc3ce3 (diff)
downloadcowboy-fad0ac8fb68833e8b7b0895eb1b96bb068961917.tar.gz
cowboy-fad0ac8fb68833e8b7b0895eb1b96bb068961917.tar.bz2
cowboy-fad0ac8fb68833e8b7b0895eb1b96bb068961917.zip
Document the set_options stream handler command
Diffstat (limited to 'doc/src/manual/cowboy_stream.asciidoc')
-rw-r--r--doc/src/manual/cowboy_stream.asciidoc18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/src/manual/cowboy_stream.asciidoc b/doc/src/manual/cowboy_stream.asciidoc
index 3b47d42..b1cab3f 100644
--- a/doc/src/manual/cowboy_stream.asciidoc
+++ b/doc/src/manual/cowboy_stream.asciidoc
@@ -257,6 +257,22 @@ Log a message.
This command can be used to log a message using the
configured `logger` module.
+=== set_options
+
+Set protocol options.
+
+[source,erlang]
+----
+{set_options, map()}
+----
+
+This can also be used to override stream handler
+options. For example this is supported by
+link:man:cowboy_compress_h(3)[cowboy_compress_h(3)].
+
+Not all options can be overriden. Please consult the
+relevant option's documentation for details.
+
== Predefined events
Cowboy will forward all messages sent to the stream to
@@ -377,7 +393,7 @@ tuple.
== Changelog
-* *2.7*: The `log` command was introduced.
+* *2.7*: The `log` and `set_options` commands were introduced.
* *2.6*: The `data` command can now contain a sendfile tuple.
* *2.6*: The `{stop, {exit, any()}, HumanReadable}` terminate reason was added.
* *2.2*: The `trailers` command was introduced.