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

Add inactivity_timeout and other options improvements

Browse source
This commit is contained in:
Loïc Hoguin 2017-05-05 13:48:25 +02:00
parent 6100470c90
commit 7db724f04a
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
5 changed files with 98 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

57
doc/src/manual/cowboy_http.asciidoc
View file

@ -11,25 +11,30 @@ as a Ranch protocol.
== Options
// @todo Might be worth moving cowboy_clear/tls/stream_h options
// to their respective manual, when they are added.
[source,erlang]
----
opts() :: #{
env := cowboy_middleware:env(),
idle_timeout := timeout(),
max_empty_lines := non_neg_integer(),
max_header_name_length := non_neg_integer(),
max_header_value_length := non_neg_integer(),
max_headers := non_neg_integer(),
max_keepalive := non_neg_integer(),
max_method_length := non_neg_integer(),
max_request_line_length := non_neg_integer(),
middlewares := [module()],
request_timeout := timeout()
connection_type => worker | supervisor,
env => cowboy_middleware:env(),
idle_timeout => timeout(),
inactivity_timeout => timeout(),
max_empty_lines => non_neg_integer(),
max_header_name_length => non_neg_integer(),
max_header_value_length => non_neg_integer(),
max_headers => non_neg_integer(),
max_keepalive => non_neg_integer(),
max_method_length => non_neg_integer(),
max_request_line_length => non_neg_integer(),
middlewares => [module()],
request_timeout => timeout(),
shutdown_timeout => timeout(),
stream_handlers => [module()]
}
----
// @todo Document the shutdown option.
Configuration for the HTTP/1.1 protocol.
This configuration is passed to Cowboy when starting listeners
@ -41,12 +46,18 @@ Ranch functions `ranch:get_protocol_options/1` and
The default value is given next to the option name:
connection_type (supervisor)::
Whether the connection process also acts as a supervisor.
env (#{})::
Middleware environment.
idle_timeout (60000)::
Time in ms with no data received before Cowboy closes the connection.
inactivity_timeout (300000)::
Time in ms with nothing received at all before Cowboy closes the connection.
max_empty_lines (5)::
Maximum number of empty lines before a request.
@ -62,24 +73,34 @@ max_headers (100)::
max_keepalive (100)::
Maximum number of requests allowed per connection.
max_request_line_length (8000)::
Maximum length of the request line.
max_method_length (32)::
Maximum length of the method.
max_request_line_length (8000)::
Maximum length of the request line.
middlewares ([cowboy_router, cowboy_handler])::
Middlewares to run for every request.
request_timeout (5000)::
Time in ms with no requests before Cowboy closes the connection.
shutdown_timeout (5000)::
Time in ms Cowboy will wait for child processes to shut down before killing them.
stream_handlers ([cowboy_stream_h])::
Ordered list of stream handlers that will handle all stream events.
== Changelog
* *2.0*: The `timeout` option was renamed `request_timeout`.
* *2.0*: The `idle_timeout`, `inactivity_timeout` and `shutdown_timeout` options were added.
* *2.0*: The `max_method_length` option was added.
* *2.0*: The `env` option is now a map instead of a proplist.
* *2.0*: The `max_request_line_length` default was increased from 4096 to 8000.
* *2.0*: The `compress` option was temporarily removed.
* *2.0*: The `connection_type` option was added.
* *2.0*: The `env` option is now a map instead of a proplist.
* *2.0*: The `stream_handlers` option was added.
* *2.0*: The `compress` option was removed in favor of the `cowboy_compress_h` stream handler.
* *2.0*: Options are now a map instead of a proplist.
* *2.0*: Protocol introduced. Replaces `cowboy_protocol`.

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

@ -11,12 +11,19 @@ as a Ranch protocol.
== Options
// @todo Might be worth moving cowboy_clear/tls/stream_h options
// to their respective manual, when they are added.
[source,erlang]
----
opts() :: #{
env := cowboy_middleware:env(),
middlewares := [module()],
preface_timeout := timeout()
connection_type => worker | supervisor,
env => cowboy_middleware:env(),
inactivity_timeout => timeout(),
middlewares => [module()],
preface_timeout => timeout(),
shutdown_timeout => timeout(),
stream_handlers => [module()]
}
----
@ -31,15 +38,27 @@ Ranch functions `ranch:get_protocol_options/1` and
The default value is given next to the option name:
connection_type (supervisor)::
Whether the connection process also acts as a supervisor.
env (#{})::
Middleware environment.
inactivity_timeout (300000)::
Time in ms with nothing received at all before Cowboy closes the connection.
middlewares ([cowboy_router, cowboy_handler])::
Middlewares to run for every request.
preface_timeout (5000)::
Time in ms Cowboy is willing to wait for the connection preface.
shutdown_timeout (5000)::
Time in ms Cowboy will wait for child processes to shut down before killing them.
stream_handlers ([cowboy_stream_h])::
Ordered list of stream handlers that will handle all stream events.
== Changelog
* *2.0*: Protocol introduced.