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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<title>Nine Nines: cowboy_http(3)</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=7" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>cowboy_http(3)</span></h1>
<h2 id="_name">Name</h2>
<p>cowboy_http - HTTP/1.1</p>
<h2 id="_description">Description</h2>
<p>The module <code>cowboy_http</code> implements HTTP/1.1 and HTTP/1.0 as a Ranch protocol.</p>
<h2 id="_options">Options</h2>
<!-- @todo Might be worth moving cowboy_clear/tls options-->
<!-- to their respective manual, when they are added.-->
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{
<font color="#0000FF">active_n</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(),
<font color="#0000FF">chunked</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(),
<font color="#0000FF">connection_type</font> <font color="#990000">=></font> <font color="#FF6600">worker</font> | <font color="#FF6600">supervisor</font>,
<font color="#0000FF">http10_keepalive</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(),
<font color="#0000FF">idle_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(),
<font color="#0000FF">inactivity_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(),
<font color="#0000FF">initial_stream_flow_size</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">linger_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(),
<font color="#0000FF">logger</font> <font color="#990000">=></font> <b><font color="#000000">module</font></b>(),
<font color="#0000FF">max_empty_lines</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_header_name_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_header_value_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_headers</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_keepalive</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_method_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_request_line_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">max_skip_body_length</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(),
<font color="#0000FF">proxy_header</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(),
<font color="#0000FF">request_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(),
<font color="#0000FF">sendfile</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(),
<font color="#0000FF">stream_handlers</font> <font color="#990000">=></font> [<b><font color="#000000">module</font></b>()]
}</tt></pre>
</div></div>
<p>Configuration for the HTTP/1.1 protocol.</p>
<p>This configuration is passed to Cowboy when starting listeners using <code>cowboy:start_clear/3</code> or <code>cowboy:start_tls/3</code> functions.</p>
<p>It can be updated without restarting listeners using the Ranch functions <code>ranch:get_protocol_options/1</code> and <code>ranch:set_protocol_options/2</code>.</p>
<p>The default value is given next to the option name:</p>
<dl><dt>active_n (100)</dt>
<dd><p>The number of packets Cowboy will request from the socket at once. This can be used to tweak the performance of the server. Higher values reduce the number of times Cowboy need to request more packets from the port driver at the expense of potentially higher memory being used.</p>
</dd>
<dt>chunked (true)</dt>
<dd><p>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.</p>
<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</p>
</dd>
<dt>connection_type (supervisor)</dt>
<dd><p>Whether the connection process also acts as a supervisor.</p>
</dd>
<dt>http10_keepalive (true)</dt>
<dd><p>Whether keep-alive is enabled for HTTP/1.0 connections.</p>
</dd>
<dt>idle_timeout (60000)</dt>
<dd><p>Time in ms with no data received before Cowboy closes the connection.</p>
<p>This option can be updated at any time using the <code>set_options</code> stream handler command.</p>
</dd>
<dt>inactivity_timeout (300000)</dt>
<dd><p>Time in ms with nothing received at all before Cowboy closes the connection.</p>
</dd>
<dt>initial_stream_flow_size (65535)</dt>
<dd><p>Amount of data in bytes Cowboy will read from the socket right after a request was fully received. This is a soft limit.</p>
</dd>
<dt>linger_timeout (1000)</dt>
<dd><p>Time in ms that Cowboy will wait when closing the connection. This is necessary to avoid the TCP reset problem as described in the <a href="https://tools.ietf.org/html/rfc7230#section-6.6">section 6.6 of RFC7230</a>.</p>
</dd>
<dt>logger (error_logger)</dt>
<dd><p>The module that will be used to write log messages.</p>
</dd>
<dt>max_empty_lines (5)</dt>
<dd><p>Maximum number of empty lines before a request.</p>
</dd>
<dt>max_header_name_length (64)</dt>
<dd><p>Maximum length of header names.</p>
</dd>
<dt>max_header_value_length (4096)</dt>
<dd><p>Maximum length of header values.</p>
</dd>
<dt>max_headers (100)</dt>
<dd><p>Maximum number of headers allowed per request.</p>
</dd>
<dt>max_keepalive (1000)</dt>
<dd><p>Maximum number of requests allowed per connection.</p>
</dd>
<dt>max_method_length (32)</dt>
<dd><p>Maximum length of the method.</p>
</dd>
<dt>max_request_line_length (8000)</dt>
<dd><p>Maximum length of the request line.</p>
</dd>
<dt>max_skip_body_length (1000000)</dt>
<dd><p>Maximum length Cowboy is willing to skip when the user code did not read the body fully. When the remaining length is too large or unknown Cowboy will close the connection.</p>
</dd>
<dt>proxy_header (false)</dt>
<dd><p>Whether incoming connections have a PROXY protocol header. The proxy information will be passed forward via the <code>proxy_header</code> key of the Req object.</p>
</dd>
<dt>request_timeout (5000)</dt>
<dd><p>Time in ms with no requests before Cowboy closes the connection.</p>
</dd>
<dt>sendfile (true)</dt>
<dd><p>Whether the sendfile syscall may be used. It can be useful to disable it on systems where the syscall has a buggy implementation, for example under VirtualBox when using shared folders.</p>
</dd>
<dt>stream_handlers ([cowboy_stream_h])</dt>
<dd><p>Ordered list of stream handlers that will handle all stream events.</p>
</dd>
</dl>
<h2 id="_changelog">Changelog</h2>
<ul><li><strong>2.8</strong>: The <code>active_n</code> option was added.
</li>
<li><strong>2.7</strong>: The <code>initial_stream_flow_size</code> and <code>logger</code> options were added.
</li>
<li><strong>2.6</strong>: The <code>chunked</code>, <code>http10_keepalive</code>, <code>proxy_header</code> and <code>sendfile</code> options were added.
</li>
<li><strong>2.5</strong>: The <code>linger_timeout</code> option was added.
</li>
<li><strong>2.2</strong>: The <code>max_skip_body_length</code> option was added.
</li>
<li><strong>2.0</strong>: The <code>timeout</code> option was renamed <code>request_timeout</code>.
</li>
<li><strong>2.0</strong>: The <code>idle_timeout</code>, <code>inactivity_timeout</code> and <code>shutdown_timeout</code> options were added.
</li>
<li><strong>2.0</strong>: The <code>max_method_length</code> option was added.
</li>
<li><strong>2.0</strong>: The <code>max_request_line_length</code> default was increased from 4096 to 8000.
</li>
<li><strong>2.0</strong>: The <code>connection_type</code> option was added.
</li>
<li><strong>2.0</strong>: The <code>env</code> option is now a map instead of a proplist.
</li>
<li><strong>2.0</strong>: The <code>stream_handlers</code> option was added.
</li>
<li><strong>2.0</strong>: The <code>compress</code> option was removed in favor of the <code>cowboy_compress_h</code> stream handler.
</li>
<li><strong>2.0</strong>: Options are now a map instead of a proplist.
</li>
<li><strong>2.0</strong>: Protocol introduced. Replaces <code>cowboy_protocol</code>.
</li>
</ul>
<h2 id="_see_also">See also</h2>
<p><a href="..">cowboy(7)</a>, <a href="../cowboy_http2">cowboy_http2(3)</a>, <a href="../cowboy_websocket">cowboy_websocket(3)</a></p>
</div>
<div class="span3 sidecol">
<h3>
Cowboy
2.9
Function Reference
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.9/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.9/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li>
<li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li>
<li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li>
<li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li>
<li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li>
<li><a href="/docs/en/cowboy/2.4/manual">2.4</a></li>
</ul>
<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
