diff options
Diffstat (limited to 'docs/en/cowboy/2.0/manual/cowboy_http/index.html')
| -rw-r--r-- | docs/en/cowboy/2.0/manual/cowboy_http/index.html | 272 |
1 files changed, 71 insertions, 201 deletions
diff --git a/docs/en/cowboy/2.0/manual/cowboy_http/index.html b/docs/en/cowboy/2.0/manual/cowboy_http/index.html index 50f6d20f..8a635726 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_http/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_http/index.html @@ -62,240 +62,110 @@ <h1 class="lined-header"><span>cowboy_http(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>cowboy_http - HTTP/1.1</p></div> -</div> -</div> -<div class="sect1"> +<p>cowboy_http - HTTP/1.1</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The module <code>cowboy_http</code> implements HTTP/1.1 and HTTP/1.0 -as a Ranch protocol.</p></div> -</div> -</div> -<div class="sect1"> +<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> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<!-- @todo Might be worth moving cowboy_clear/tls/stream_h options--> +<!-- to their respective manual, when they are added.--> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="font-weight: bold"><span style="color: #000000">opts</span></span>() <span style="color: #990000">::</span> #{ - <span style="color: #0000FF">connection_type</span> <span style="color: #990000">=></span> <span style="color: #FF6600">worker</span> | <span style="color: #FF6600">supervisor</span>, - <span style="color: #0000FF">env</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">cowboy_middleware:env</span></span>(), - <span style="color: #0000FF">idle_timeout</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(), - <span style="color: #0000FF">inactivity_timeout</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(), - <span style="color: #0000FF">max_empty_lines</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">max_header_name_length</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">max_header_value_length</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">max_headers</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">max_keepalive</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">max_method_length</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">max_request_line_length</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">middlewares</span> <span style="color: #990000">=></span> [<span style="font-weight: bold"><span style="color: #000000">module</span></span>()], - <span style="color: #0000FF">request_timeout</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(), - <span style="color: #000080">shutdown</span><span style="color: #009900">_timeout</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(), - <span style="color: #0000FF">stream_handlers</span> <span style="color: #990000">=></span> [<span style="font-weight: bold"><span style="color: #000000">module</span></span>()] -}</tt></pre></div></div> -<div class="paragraph"><p>Configuration for the HTTP/1.1 protocol.</p></div> -<div class="paragraph"><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></div> -<div class="paragraph"><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></div> -<div class="paragraph"><p>The default value is given next to the option name:</p></div> -<div class="dlist"><dl> -<dt class="hdlist1"> -connection_type (supervisor) -</dt> -<dd> -<p> - Whether the connection process also acts as a supervisor. -</p> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">connection_type</font> <font color="#990000">=></font> <font color="#FF6600">worker</font> | <font color="#FF6600">supervisor</font>, + <font color="#0000FF">env</font> <font color="#990000">=></font> <b><font color="#000000">cowboy_middleware:env</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">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">middlewares</font> <font color="#990000">=></font> [<b><font color="#000000">module</font></b>()], + <font color="#0000FF">request_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#000080">shutdown</font><font color="#009900">_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</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>connection_type (supervisor)</dt> +<dd><p>Whether the connection process also acts as a supervisor.</p> </dd> -<dt class="hdlist1"> -env (#{}) -</dt> -<dd> -<p> - Middleware environment. -</p> +<dt>env (#{})</dt> +<dd><p>Middleware environment.</p> </dd> -<dt class="hdlist1"> -idle_timeout (60000) -</dt> -<dd> -<p> - Time in ms with no data received before Cowboy closes the connection. -</p> +<dt>idle_timeout (60000)</dt> +<dd><p>Time in ms with no data received before Cowboy closes the connection.</p> </dd> -<dt class="hdlist1"> -inactivity_timeout (300000) -</dt> -<dd> -<p> - Time in ms with nothing received at all before Cowboy closes the connection. -</p> +<dt>inactivity_timeout (300000)</dt> +<dd><p>Time in ms with nothing received at all before Cowboy closes the connection.</p> </dd> -<dt class="hdlist1"> -max_empty_lines (5) -</dt> -<dd> -<p> - Maximum number of empty lines before a request. -</p> +<dt>max_empty_lines (5)</dt> +<dd><p>Maximum number of empty lines before a request.</p> </dd> -<dt class="hdlist1"> -max_header_name_length (64) -</dt> -<dd> -<p> - Maximum length of header names. -</p> +<dt>max_header_name_length (64)</dt> +<dd><p>Maximum length of header names.</p> </dd> -<dt class="hdlist1"> -max_header_value_length (4096) -</dt> -<dd> -<p> - Maximum length of header values. -</p> +<dt>max_header_value_length (4096)</dt> +<dd><p>Maximum length of header values.</p> </dd> -<dt class="hdlist1"> -max_headers (100) -</dt> -<dd> -<p> - Maximum number of headers allowed per request. -</p> +<dt>max_headers (100)</dt> +<dd><p>Maximum number of headers allowed per request.</p> </dd> -<dt class="hdlist1"> -max_keepalive (100) -</dt> -<dd> -<p> - Maximum number of requests allowed per connection. -</p> +<dt>max_keepalive (100)</dt> +<dd><p>Maximum number of requests allowed per connection.</p> </dd> -<dt class="hdlist1"> -max_method_length (32) -</dt> -<dd> -<p> - Maximum length of the method. -</p> +<dt>max_method_length (32)</dt> +<dd><p>Maximum length of the method.</p> </dd> -<dt class="hdlist1"> -max_request_line_length (8000) -</dt> -<dd> -<p> - Maximum length of the request line. -</p> +<dt>max_request_line_length (8000)</dt> +<dd><p>Maximum length of the request line.</p> </dd> -<dt class="hdlist1"> -middlewares ([cowboy_router, cowboy_handler]) -</dt> -<dd> -<p> - Middlewares to run for every request. -</p> +<dt>middlewares ([cowboy_router, cowboy_handler])</dt> +<dd><p>Middlewares to run for every request.</p> </dd> -<dt class="hdlist1"> -request_timeout (5000) -</dt> -<dd> -<p> - Time in ms with no requests before Cowboy closes the connection. -</p> +<dt>request_timeout (5000)</dt> +<dd><p>Time in ms with no requests before Cowboy closes the connection.</p> </dd> -<dt class="hdlist1"> -shutdown_timeout (5000) -</dt> -<dd> -<p> - Time in ms Cowboy will wait for child processes to shut down before killing them. -</p> +<dt>shutdown_timeout (5000)</dt> +<dd><p>Time in ms Cowboy will wait for child processes to shut down before killing them.</p> </dd> -<dt class="hdlist1"> -stream_handlers ([cowboy_stream_h]) -</dt> -<dd> -<p> - Ordered list of stream handlers that will handle all stream events. -</p> +<dt>stream_handlers ([cowboy_stream_h])</dt> +<dd><p>Ordered list of stream handlers that will handle all stream events.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>2.0</strong>: The <code>timeout</code> option was renamed <code>request_timeout</code>. -</p> +<ul><li><strong>2.0</strong>: The <code>timeout</code> option was renamed <code>request_timeout</code>. </li> -<li> -<p> -<strong>2.0</strong>: The <code>idle_timeout</code>, <code>inactivity_timeout</code> and <code>shutdown_timeout</code> options were added. -</p> +<li><strong>2.0</strong>: The <code>idle_timeout</code>, <code>inactivity_timeout</code> and <code>shutdown_timeout</code> options were added. </li> -<li> -<p> -<strong>2.0</strong>: The <code>max_method_length</code> option was added. -</p> +<li><strong>2.0</strong>: The <code>max_method_length</code> option was added. </li> -<li> -<p> -<strong>2.0</strong>: The <code>max_request_line_length</code> default was increased from 4096 to 8000. -</p> +<li><strong>2.0</strong>: The <code>max_request_line_length</code> default was increased from 4096 to 8000. </li> -<li> -<p> -<strong>2.0</strong>: The <code>connection_type</code> option was added. -</p> +<li><strong>2.0</strong>: The <code>connection_type</code> option was added. </li> -<li> -<p> -<strong>2.0</strong>: The <code>env</code> option is now a map instead of a proplist. -</p> +<li><strong>2.0</strong>: The <code>env</code> option is now a map instead of a proplist. </li> -<li> -<p> -<strong>2.0</strong>: The <code>stream_handlers</code> option was added. -</p> +<li><strong>2.0</strong>: The <code>stream_handlers</code> option was added. </li> -<li> -<p> -<strong>2.0</strong>: The <code>compress</code> option was removed in favor of the <code>cowboy_compress_h</code> stream handler. -</p> +<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> -<p> -<strong>2.0</strong>: Options are now a map instead of a proplist. -</p> +<li><strong>2.0</strong>: Options are now a map instead of a proplist. </li> -<li> -<p> -<strong>2.0</strong>: Protocol introduced. Replaces <code>cowboy_protocol</code>. -</p> +<li><strong>2.0</strong>: Protocol introduced. Replaces <code>cowboy_protocol</code>. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><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> -</div> +<p><a href="..">cowboy(7)</a>, <a href="../cowboy_http2">cowboy_http2(3)</a>, <a href="../cowboy_websocket">cowboy_websocket(3)</a></p> + |