summaryrefslogtreecommitdiffstats
path: root/docs/en/cowboy/2.4/manual/cowboy_http2
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-13 09:54:12 +0200
committerLoïc Hoguin <[email protected]>2018-06-13 09:54:12 +0200
commit92b54aacc0de5446dd5497c39897b0bbff72e626 (patch)
treec3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/cowboy/2.4/manual/cowboy_http2
parent8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff)
downloadninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz
ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2
ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip
Rebuild using Asciideck
Diffstat (limited to 'docs/en/cowboy/2.4/manual/cowboy_http2')
-rw-r--r--docs/en/cowboy/2.4/manual/cowboy_http2/index.html279
1 files changed, 69 insertions, 210 deletions
diff --git a/docs/en/cowboy/2.4/manual/cowboy_http2/index.html b/docs/en/cowboy/2.4/manual/cowboy_http2/index.html
index ec1b8d28..9b915b91 100644
--- a/docs/en/cowboy/2.4/manual/cowboy_http2/index.html
+++ b/docs/en/cowboy/2.4/manual/cowboy_http2/index.html
@@ -62,243 +62,102 @@
<h1 class="lined-header"><span>cowboy_http2(3)</span></h1>
-<div class="sect1">
<h2 id="_name">Name</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>cowboy_http2 - HTTP/2</p></div>
-</div>
-</div>
-<div class="sect1">
+<p>cowboy_http2 - HTTP/2</p>
<h2 id="_description">Description</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>The module <code>cowboy_http2</code> implements HTTP/2
-as a Ranch protocol.</p></div>
-</div>
-</div>
-<div class="sect1">
+<p>The module <code>cowboy_http2</code> implements HTTP/2 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">=&gt;</span> <span style="color: #FF6600">worker</span> | <span style="color: #FF6600">supervisor</span>,
- <span style="color: #0000FF">enable_connect_protocol</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">boolean</span></span>(),
- <span style="color: #0000FF">env</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">cowboy_middleware:env</span></span>(),
- <span style="color: #0000FF">inactivity_timeout</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(),
- <span style="color: #0000FF">initial_connection_window_size</span> <span style="color: #990000">=&gt;</span> <span style="color: #993399">65535</span><span style="color: #990000">..</span><span style="color: #993399">16#7fffffff</span>,
- <span style="color: #0000FF">initial_stream_window_size</span> <span style="color: #990000">=&gt;</span> <span style="color: #993399">0</span><span style="color: #990000">..</span><span style="color: #993399">16#7fffffff</span>,
- <span style="color: #0000FF">max_concurrent_streams</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>() | <span style="color: #FF6600">infinity</span>,
- <span style="color: #0000FF">max_decode_table_size</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(),
- <span style="color: #0000FF">max_encode_table_size</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(),
- <span style="color: #0000FF">max_frame_size_received</span> <span style="color: #990000">=&gt;</span> <span style="color: #993399">16384</span><span style="color: #990000">..</span><span style="color: #993399">16777215</span>,
- <span style="color: #0000FF">max_frame_size_sent</span> <span style="color: #990000">=&gt;</span> <span style="color: #993399">16384</span><span style="color: #990000">..</span><span style="color: #993399">16777215</span> | <span style="color: #FF6600">infinity</span>,
- <span style="color: #0000FF">middlewares</span> <span style="color: #990000">=&gt;</span> [<span style="font-weight: bold"><span style="color: #000000">module</span></span>()],
- <span style="color: #0000FF">preface_timeout</span> <span style="color: #990000">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(),
- <span style="color: #0000FF">settings_timeout</span> <span style="color: #990000">=&gt;</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">=&gt;</span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(),
- <span style="color: #0000FF">stream_handlers</span> <span style="color: #990000">=&gt;</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/2 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">=&gt;</font> <font color="#FF6600">worker</font> | <font color="#FF6600">supervisor</font>,
+ <font color="#0000FF">enable_connect_protocol</font> <font color="#990000">=&gt;</font> <b><font color="#000000">boolean</font></b>(),
+ <font color="#0000FF">env</font> <font color="#990000">=&gt;</font> <b><font color="#000000">cowboy_middleware:env</font></b>(),
+ <font color="#0000FF">inactivity_timeout</font> <font color="#990000">=&gt;</font> <b><font color="#000000">timeout</font></b>(),
+ <font color="#0000FF">initial_connection_window_size</font> <font color="#990000">=&gt;</font> <font color="#993399">65535</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>,
+ <font color="#0000FF">initial_stream_window_size</font> <font color="#990000">=&gt;</font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>,
+ <font color="#0000FF">max_concurrent_streams</font> <font color="#990000">=&gt;</font> <b><font color="#000000">non_neg_integer</font></b>() | <font color="#FF6600">infinity</font>,
+ <font color="#0000FF">max_decode_table_size</font> <font color="#990000">=&gt;</font> <b><font color="#000000">non_neg_integer</font></b>(),
+ <font color="#0000FF">max_encode_table_size</font> <font color="#990000">=&gt;</font> <b><font color="#000000">non_neg_integer</font></b>(),
+ <font color="#0000FF">max_frame_size_received</font> <font color="#990000">=&gt;</font> <font color="#993399">16384</font><font color="#990000">..</font><font color="#993399">16777215</font>,
+ <font color="#0000FF">max_frame_size_sent</font> <font color="#990000">=&gt;</font> <font color="#993399">16384</font><font color="#990000">..</font><font color="#993399">16777215</font> | <font color="#FF6600">infinity</font>,
+ <font color="#0000FF">middlewares</font> <font color="#990000">=&gt;</font> [<b><font color="#000000">module</font></b>()],
+ <font color="#0000FF">preface_timeout</font> <font color="#990000">=&gt;</font> <b><font color="#000000">timeout</font></b>(),
+ <font color="#0000FF">settings_timeout</font> <font color="#990000">=&gt;</font> <b><font color="#000000">timeout</font></b>(),
+ <font color="#000080">shutdown</font><font color="#009900">_timeout</font> <font color="#990000">=&gt;</font> <b><font color="#000000">timeout</font></b>(),
+ <font color="#0000FF">stream_handlers</font> <font color="#990000">=&gt;</font> [<b><font color="#000000">module</font></b>()]
+}</tt></pre>
+</div></div>
+<p>Configuration for the HTTP/2 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">
-enable_connect_protocol (false)
-</dt>
-<dd>
-<p>
- Whether to enable the extended CONNECT method to allow
- protocols like Websocket to be used over an HTTP/2 stream.
- This option is experimental and disabled by default.
-</p>
+<dt>enable_connect_protocol (false)</dt>
+<dd><p>Whether to enable the extended CONNECT method to allow protocols like Websocket to be used over an HTTP/2 stream. This option is experimental and disabled by default.</p>
</dd>
-<dt class="hdlist1">
-env (#{})
-</dt>
-<dd>
-<p>
- Middleware environment.
-</p>
+<dt>env (#{})</dt>
+<dd><p>Middleware environment.</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">
-initial_connection_window_size (65535)
-</dt>
-<dd>
-<p>
- Initial window size for the connection. This is the total amount
- of data (from request bodies for example) that may be buffered
- by the connection across all streams before the user code
- explicitly requests it.
-</p>
-<div class="literalblock">
-<div class="content">
-<pre><code>Note that this value cannot be lower than the default.</code></pre>
-</div></div>
+<dt>initial_connection_window_size (65535)</dt>
+<dd><p>Initial window size for the connection. This is the total amount of data (from request bodies for example) that may be buffered by the connection across all streams before the user code explicitly requests it.</p>
+<p>Note that this value cannot be lower than the default.</p>
</dd>
-<dt class="hdlist1">
-initial_stream_window_size (65535)
-</dt>
-<dd>
-<p>
- Initial window size for new streams. This is the total amount
- of data (from request bodies for example) that may be buffered
- by a single stream before the user code explicitly requests it.
-</p>
+<dt>initial_stream_window_size (65535)</dt>
+<dd><p>Initial window size for new streams. This is the total amount of data (from request bodies for example) that may be buffered by a single stream before the user code explicitly requests it.</p>
</dd>
-<dt class="hdlist1">
-max_concurrent_streams (infinity)
-</dt>
-<dd>
-<p>
- Maximum number of concurrent streams allowed on the connection.
-</p>
+<dt>max_concurrent_streams (infinity)</dt>
+<dd><p>Maximum number of concurrent streams allowed on the connection.</p>
</dd>
-<dt class="hdlist1">
-max_decode_table_size (4096)
-</dt>
-<dd>
-<p>
- Maximum header table size used by the decoder. This is the value advertised
- to the client. The client can then choose a header table size equal or lower
- to the advertised value.
-</p>
+<dt>max_decode_table_size (4096)</dt>
+<dd><p>Maximum header table size used by the decoder. This is the value advertised to the client. The client can then choose a header table size equal or lower to the advertised value.</p>
</dd>
-<dt class="hdlist1">
-max_encode_table_size (4096)
-</dt>
-<dd>
-<p>
- Maximum header table size used by the encoder. The server will compare this
- value to what the client advertises and choose the smallest one as the
- encoder&#8217;s header table size.
-</p>
+<dt>max_encode_table_size (4096)</dt>
+<dd><p>Maximum header table size used by the encoder. The server will compare this value to what the client advertises and choose the smallest one as the encoder&apos;s header table size.</p>
</dd>
-<dt class="hdlist1">
-max_frame_size_received (16384)
-</dt>
-<dd>
-<p>
- Maximum size of the frames received by the server. This value is
- advertised to the remote endpoint which can then decide to use
- any value lower or equal for its frame sizes.
-</p>
+<dt>max_frame_size_received (16384)</dt>
+<dd><p>Maximum size of the frames received by the server. This value is advertised to the remote endpoint which can then decide to use any value lower or equal for its frame sizes.</p>
</dd>
-<dt class="hdlist1">
-max_frame_size_sent (infinity)
-</dt>
-<dd>
-<p>
- Maximum size of the frames sent by the server. This option allows
- setting an upper limit to the frame sizes instead of blindly
- following the client&#8217;s advertised maximum.
-</p>
-<div class="literalblock">
-<div class="content">
-<pre><code>Note that actual frame sizes may be lower than the limit when
-there is not enough space left in the flow control window.</code></pre>
-</div></div>
+<dt>max_frame_size_sent (infinity)</dt>
+<dd><p>Maximum size of the frames sent by the server. This option allows setting an upper limit to the frame sizes instead of blindly following the client&apos;s advertised maximum.</p>
+<p>Note that actual frame sizes may be lower than the limit when there is not enough space left in the flow control window.</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">
-preface_timeout (5000)
-</dt>
-<dd>
-<p>
- Time in ms Cowboy is willing to wait for the connection preface.
-</p>
+<dt>preface_timeout (5000)</dt>
+<dd><p>Time in ms Cowboy is willing to wait for the connection preface.</p>
</dd>
-<dt class="hdlist1">
-settings_timeout (5000)
-</dt>
-<dd>
-<p>
- Time in ms Cowboy is willing to wait for a SETTINGS ack.
-</p>
+<dt>settings_timeout (5000)</dt>
+<dd><p>Time in ms Cowboy is willing to wait for a SETTINGS ack.</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.4</strong>: Add the options <code>initial_connection_window_size</code>,
- <code>initial_stream_window_size</code>, <code>max_concurrent_streams</code>,
- <code>max_decode_table_size</code>, <code>max_encode_table_size</code>,
- <code>max_frame_size_received</code>, <code>max_frame_size_sent</code>
- and <code>settings_timeout</code> to configure HTTP/2 SETTINGS
- and related behavior.
-</p>
+<ul><li><strong>2.4</strong>: Add the options <code>initial_connection_window_size</code>, <code>initial_stream_window_size</code>, <code>max_concurrent_streams</code>, <code>max_decode_table_size</code>, <code>max_encode_table_size</code>, <code>max_frame_size_received</code>, <code>max_frame_size_sent</code> and <code>settings_timeout</code> to configure HTTP/2 SETTINGS and related behavior.
</li>
-<li>
-<p>
-<strong>2.4</strong>: Add the experimental option <code>enable_connect_protocol</code>.
-</p>
+<li><strong>2.4</strong>: Add the experimental option <code>enable_connect_protocol</code>.
</li>
-<li>
-<p>
-<strong>2.0</strong>: Protocol introduced.
-</p>
+<li><strong>2.0</strong>: Protocol introduced.
</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_http">cowboy_http(3)</a>,
-<a href="../cowboy_websocket">cowboy_websocket(3)</a></p></div>
-</div>
-</div>
+<p><a href="..">cowboy(7)</a>, <a href="../cowboy_http">cowboy_http(3)</a>, <a href="../cowboy_websocket">cowboy_websocket(3)</a></p>
+