umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00
Code Issues Wiki Activity

Document the HTTP/2 linger_timeout option

Browse source
This commit is contained in:
Loïc Hoguin 2020-04-08 10:27:45 +02:00
parent f58189df19
commit 8af3216c4c
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/src/manual/cowboy_http2.asciidoc
View file

@ -26,6 +26,7 @@ opts() :: #{
inactivity_timeout => timeout(), inactivity_timeout => timeout(),
initial_connection_window_size => 65535..16#7fffffff, initial_connection_window_size => 65535..16#7fffffff,
initial_stream_window_size => 0..16#7fffffff, initial_stream_window_size => 0..16#7fffffff,
linger_timeout => timeout(),
logger => module(), logger => module(),
max_concurrent_streams => non_neg_integer() | infinity, max_concurrent_streams => non_neg_integer() | infinity,
max_connection_buffer_size => non_neg_integer(), 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 of data (from request bodies for example) that may be buffered
by a single stream before the user code explicitly requests it. 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):: logger (error_logger)::
The module that will be used to write log messages. The module that will be used to write log messages.
@ -236,6 +245,7 @@ too many `WINDOW_UPDATE` frames.
== Changelog == Changelog
* *2.8*: The `active_n` option was added. * *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 * *2.8*: The `max_received_frame_rate` default value has
been multiplied by 10 as the default was too low. been multiplied by 10 as the default was too low.
* *2.7*: Add the options `connection_window_margin_size`, * *2.7*: Add the options `connection_window_margin_size`,