path: root/doc
diff options
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
parente25fb19bab02ba7fee68d5188d340311fffc3ce3 (diff)
Document the set_options stream handler command
Diffstat (limited to 'doc')
4 files changed, 32 insertions, 1 deletions
diff --git a/doc/src/manual/cowboy_compress_h.asciidoc b/doc/src/manual/cowboy_compress_h.asciidoc
index c1d7b20..31a9162 100644
--- a/doc/src/manual/cowboy_compress_h.asciidoc
+++ b/doc/src/manual/cowboy_compress_h.asciidoc
@@ -37,11 +37,17 @@ compress_buffering (false)::
Whether the output will be buffered. By default no
buffering is done to provide maximum compatibility
at the cost of a lower compression rate.
+This option can be updated at any time using the
+`set_options` stream handler command.
compress_threshold (300)::
How large the response body must be to be compressed
when the response isn't streamed.
+This option can be updated at any time using the
+`set_options` stream handler command.
== Events
diff --git a/doc/src/manual/cowboy_http.asciidoc b/doc/src/manual/cowboy_http.asciidoc
index 7ade577..e9837c3 100644
--- a/doc/src/manual/cowboy_http.asciidoc
+++ b/doc/src/manual/cowboy_http.asciidoc
@@ -56,6 +56,9 @@ Whether chunked transfer-encoding is enabled for HTTP/1.1 connections.
Note that a response streamed to the client without the chunked
transfer-encoding and without a content-length header will result
in the connection being closed at the end of the response body.
+This option can be updated at any time using the
+`set_options` stream handler command.
connection_type (supervisor)::
@@ -68,6 +71,9 @@ Whether keep-alive is enabled for HTTP/1.0 connections.
idle_timeout (60000)::
Time in ms with no data received before Cowboy closes the connection.
+This option can be updated at any time using the
+`set_options` stream handler command.
inactivity_timeout (300000)::
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.
+{set_options, map()}
+This can also be used to override stream handler
+options. For example this is supported by
+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.
diff --git a/doc/src/manual/cowboy_websocket.asciidoc b/doc/src/manual/cowboy_websocket.asciidoc
index 3a2264b..440a0e8 100644
--- a/doc/src/manual/cowboy_websocket.asciidoc
+++ b/doc/src/manual/cowboy_websocket.asciidoc
@@ -232,6 +232,9 @@ idle_timeout (60000)::
Time in milliseconds that Cowboy will keep the
connection open without receiving anything from
the client.
+This option can be updated at any time using the
+`set_options` command.
max_frame_size (infinity)::