diff options
Diffstat (limited to 'docs/en/gun/2.0/manual/gun/index.html')
| -rw-r--r-- | docs/en/gun/2.0/manual/gun/index.html | 66 |
1 files changed, 50 insertions, 16 deletions
diff --git a/docs/en/gun/2.0/manual/gun/index.html b/docs/en/gun/2.0/manual/gun/index.html index 2ee49896..7cf1858f 100644 --- a/docs/en/gun/2.0/manual/gun/index.html +++ b/docs/en/gun/2.0/manual/gun/index.html @@ -136,7 +136,7 @@ <p>Connection:</p> <ul><li><a href="../gun_up">gun_up(3)</a> - The connection is up </li> -<li><a href="../gun_socks_up">gun_socks_up(3)</a> - The Socks connection is up +<li><a href="../gun_tunnel_up">gun_tunnel_up(3)</a> - The tunnel is up </li> <li><a href="../gun_down">gun_down(3)</a> - The connection is down </li> @@ -210,11 +210,12 @@ by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><b><font color="#000000">http_opts</font></b>() <font color="#990000">::</font> #{ - <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), - <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), - <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), - <font color="#0000FF">transform_header_name</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000080">binary</font></b>()) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>()), - <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font> + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">cookie_ignore_informational</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">transform_header_name</font> <font color="#990000">=></font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000080">binary</font></b>()) <font color="#990000">-></font> <b><font color="#000080">binary</font></b>()), + <font color="#0000FF">version</font> <font color="#990000">=></font> <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font> }</tt></pre> </div></div> <p>Configuration for the HTTP protocol.</p> @@ -223,6 +224,9 @@ http://www.gnu.org/software/src-highlite --> <dl><dt>closing_timeout (15000)</dt> <dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested via a call to <a href="../gun.shutdown">gun:shutdown(3)</a>.</p> </dd> +<dt>cookie_ignore_informational (false)</dt> +<dd><p>Whether cookies received inside informational responses (1xx status code) must be ignored.</p> +</dd> <dt>flow - see below</dt> <dd><p>The initial flow control value for all HTTP/1.1 streams. By default flow control is disabled.</p> </dd> @@ -242,9 +246,10 @@ by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt><b><font color="#000000">http2_opts</font></b>() <font color="#990000">::</font> #{ - <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), - <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), - <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">closing_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">cookie_ignore_informational</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">flow</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), <i><font color="#9A1900">%% HTTP/2 state machine configuration.</font></i> <font color="#0000FF">connection_window_margin_size</font> <font color="#990000">=></font> <font color="#993399">0</font><font color="#990000">..</font><font color="#993399">16#7fffffff</font>, @@ -272,10 +277,13 @@ http://www.gnu.org/software/src-highlite --> <dl><dt>closing_timeout (15000)</dt> <dd><p>Time to wait before brutally closing the connection when a graceful shutdown was requested either via a call to <a href="../gun.shutdown">gun:shutdown(3)</a> or by the server.</p> </dd> +<dt>cookie_ignore_informational (false)</dt> +<dd><p>Whether cookies received inside informational responses (1xx status code) must be ignored.</p> +</dd> <dt>flow - see below</dt> <dd><p>The initial flow control value for all HTTP/2 streams. By default flow control is disabled.</p> </dd> -<dt>keepalive (5000)</dt> +<dt>keepalive (infinity)</dt> <dd><p>Time between pings in milliseconds.</p> </dd> </dl> @@ -374,12 +382,25 @@ http://www.gnu.org/software/src-highlite --> by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><b><font color="#000000">protocols</font></b>() <font color="#990000">::</font> <font color="#FF6600">http</font> | {<font color="#FF6600">http</font>, <b><font color="#000000">http_opts</font></b>()} - | <font color="#FF6600">http2</font> | {<font color="#FF6600">http2</font>, <b><font color="#000000">http2_opts</font></b>()} - | <font color="#FF6600">socks</font> | {<font color="#FF6600">socks</font>, <b><font color="#000000">socks_opts</font></b>()}</tt></pre> +<pre><tt><font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | {<font color="#FF6600">http</font>, <b><font color="#000000">http_opts</font></b>()} + | <font color="#FF6600">http2</font> | {<font color="#FF6600">http2</font>, <b><font color="#000000">http2_opts</font></b>()} + | <font color="#FF6600">raw</font> | {<font color="#FF6600">raw</font>, <b><font color="#000000">raw_opts</font></b>()} + | <font color="#FF6600">socks</font> | {<font color="#FF6600">socks</font>, <b><font color="#000000">socks_opts</font></b>()} + +<b><font color="#000000">protocols</font></b>() <font color="#990000">::</font> [<font color="#009900">Protocol</font>]</tt></pre> </div></div> <p>Ordered list of preferred protocols. When the transport is <code>tcp</code>, this list must contain exactly one protocol. When the transport is <code>tls</code>, this list must contain at least one protocol and will be used to negotiate a protocol via ALPN. When the server does not support ALPN then <code>http</code> will be used, except when the list of preferred protocols is set to only accept <code>socks</code>.</p> <p>Defaults to <code>[http]</code> when the transport is <code>tcp</code>, and <code>[http2, http]</code> when the transport is <code>tls</code>.</p> +<h3 id="_raw_opts">raw_opts()</h3> +<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">raw_opts</font></b>() <font color="#990000">::</font> #{ +}</tt></pre> +</div></div> +<p>Configuration for the "raw" protocol.</p> +<!-- The default value is given next to the option name:--> <h3 id="_req_headers">req_headers()</h3> <div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 by Lorenzo Bettini @@ -452,6 +473,15 @@ http://www.gnu.org/software/src-highlite --> <dd><p>Version of the Socks protocol to use.</p> </dd> </dl> +<h3 id="_stream_ref">stream_ref()</h3> +<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">stream_ref</font></b>() <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font></tt></pre> +</div></div> +<p>Unique identifier for a stream.</p> +<p>The exact type is considered to be an implementation detail.</p> <h3 id="_ws_opts">ws_opts()</h3> <div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 by Lorenzo Bettini @@ -477,7 +507,7 @@ http://www.gnu.org/software/src-highlite --> <dt>flow - see below</dt> <dd><p>The initial flow control value for the Websocket connection. By default flow control is disabled.</p> </dd> -<dt>keepalive (5000)</dt> +<dt>keepalive (infinity)</dt> <dd><p>Time between pings in milliseconds.</p> </dd> <dt>protocols ([])</dt> @@ -489,7 +519,9 @@ http://www.gnu.org/software/src-highlite --> </dl> <!-- @todo Document default_protocol and user_opts.--> <h2 id="_changelog">Changelog</h2> -<ul><li><strong>2.0</strong>: The option <code>cookie_store</code> was added. It can be used to configure a cookie store that Gun will use automatically. +<ul><li><strong>2.0</strong>: The <code>stream_ref()</code> type was added. +</li> +<li><strong>2.0</strong>: The option <code>cookie_store</code> was added. It can be used to configure a cookie store that Gun will use automatically. A related option, <code>cookie_ignore_informational</code>, was added to both <code>http_opts()</code> and <code>http2_opts()</code>. </li> <li><strong>2.0</strong>: The types <code>protocols()</code> and <code>socks_opts()</code> have been added. Support for the Socks protocol has been added in every places where protocol selection is available. In addition it is now possible to specify separate HTTP options for the CONNECT proxy and the origin server. </li> @@ -505,10 +537,12 @@ http://www.gnu.org/software/src-highlite --> </li> <li><strong>2.0</strong>: Function <code>gun:headers/4,5</code> introduced. </li> -<li><strong>2.0</strong>: The <code>keepalive</code> option is now set to <code>infinity</code> by default for the HTTP/1.1 protocol, disabling it. +<li><strong>2.0</strong>: The <code>keepalive</code> option is now set to <code>infinity</code> by default for all protocols. This means it is disabled. </li> <li><strong>2.0</strong>: Websocket options <code>keepalive</code> and <code>silence_pings</code> introduced. </li> +<li><strong>2.0</strong>: Remove the <code>protocol</code> option from <code>connect_destination()</code>. +</li> <li><strong>1.3</strong>: Add the CONNECT destination's <code>protocols</code> option and deprecate the previously introduced <code>protocol</code> option. </li> <li><strong>1.2</strong>: Introduce the type <code>connect_destination()</code>. |