1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
= cowboy_http(3)
== Name
cowboy_http - HTTP/1.1
== Description
The module `cowboy_http` implements HTTP/1.1 and HTTP/1.0
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() :: #{
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()]
}
----
Configuration for the HTTP/1.1 protocol.
This configuration is passed to Cowboy when starting listeners
using `cowboy:start_clear/4` or `cowboy:start_tls/4` functions.
It can be updated without restarting listeners using the
Ranch functions `ranch:get_protocol_options/1` and
`ranch:set_protocol_options/2`.
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.
max_header_name_length (64)::
Maximum length of header names.
max_header_value_length (4096)::
Maximum length of header values.
max_headers (100)::
Maximum number of headers allowed per request.
max_keepalive (100)::
Maximum number of requests allowed per connection.
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 `max_request_line_length` default was increased from 4096 to 8000.
* *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`.
== See also
link:man:cowboy(7)[cowboy(7)],
link:man:cowboy_http2(3)[cowboy_http2(3)],
link:man:cowboy_websocket(3)[cowboy_websocket(3)]
|
