aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2020-04-08 10:27:45 +0200
committerLoïc Hoguin <[email protected]>2020-04-08 10:27:45 +0200
commit8af3216c4c84e8780d8ce92495f7cefb4d083a86 (patch)
tree4da7cb27fb80f5cd40d5267f9143f37bed1222cf
parentf58189df19a297dd9dd3911fe1f7631165fac5e8 (diff)
downloadcowboy-8af3216c4c84e8780d8ce92495f7cefb4d083a86.tar.gz
cowboy-8af3216c4c84e8780d8ce92495f7cefb4d083a86.tar.bz2
cowboy-8af3216c4c84e8780d8ce92495f7cefb4d083a86.zip
Document the HTTP/2 linger_timeout option
-rw-r--r--doc/src/manual/cowboy_http2.asciidoc10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_http2.asciidoc b/doc/src/manual/cowboy_http2.asciidoc
index e803f56..c61bfe6 100644
--- a/doc/src/manual/cowboy_http2.asciidoc
+++ b/doc/src/manual/cowboy_http2.asciidoc
@@ -26,6 +26,7 @@ opts() :: #{
inactivity_timeout => timeout(),
initial_connection_window_size => 65535..16#7fffffff,
initial_stream_window_size => 0..16#7fffffff,
+ linger_timeout => timeout(),
logger => module(),
max_concurrent_streams => non_neg_integer() | infinity,
max_connection_buffer_size => non_neg_integer(),
@@ -114,6 +115,14 @@ Initial window size in bytes for new streams. This is the total amount
of data (from request bodies for example) that may be buffered
by a single stream before the user code explicitly requests it.
+linger_timeout (1000)::
+
+Time in ms that Cowboy will wait when closing the connection. This is
+necessary to avoid the TCP reset problem as described in the
+https://tools.ietf.org/html/rfc7230#section-6.6[section 6.6 of RFC7230].
+In HTTP/2's case the GOAWAY message might also be lost when
+closing the connection immediately.
+
logger (error_logger)::
The module that will be used to write log messages.
@@ -236,6 +245,7 @@ too many `WINDOW_UPDATE` frames.
== Changelog
* *2.8*: The `active_n` option was added.
+* *2.8*: The `linger_timeout` option was added.
* *2.8*: The `max_received_frame_rate` default value has
been multiplied by 10 as the default was too low.
* *2.7*: Add the options `connection_window_margin_size`,