diff options
| author | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
| commit | 92b54aacc0de5446dd5497c39897b0bbff72e626 (patch) | |
| tree | c3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/gun | |
| parent | 8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff) | |
| download | ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2 ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip | |
Rebuild using Asciideck
Diffstat (limited to 'docs/en/gun')
40 files changed, 1836 insertions, 4272 deletions
diff --git a/docs/en/gun/1.0/guide/connect/index.html b/docs/en/gun/1.0/guide/connect/index.html index ac1e6eb3..427b7450 100644 --- a/docs/en/gun/1.0/guide/connect/index.html +++ b/docs/en/gun/1.0/guide/connect/index.html @@ -62,145 +62,104 @@ <h1 class="lined-header"><span>Connection</span></h1> -<div class="paragraph"><p>This chapter describes how to open, monitor and close -a connection using the Gun client.</p></div> -<div class="sect1"> +<p>This chapter describes how to open, monitor and close a connection using the Gun client.</p> <h2 id="_gun_connections">Gun connections</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun is designed with the HTTP/2 and Websocket protocols in mind. -They are built for long-running connections that allow concurrent -exchange of data, either in the form of request/responses for -HTTP/2 or in the form of messages for Websocket.</p></div> -<div class="paragraph"><p>A Gun connection is an Erlang process that manages a socket to -a remote endpoint. This Gun connection is owned by a user -process that is called the <em>owner</em> of the connection, and is -managed by the supervision tree of the <code>gun</code> application.</p></div> -<div class="paragraph"><p>The owner process communicates with the Gun connection -by calling functions from the module <code>gun</code>. All functions -perform their respective operations asynchronously. The Gun -connection will send Erlang messages to the owner process -whenever needed.</p></div> -<div class="paragraph"><p>When the remote endpoint closes the connection, Gun attempts -to reconnect automatically.</p></div> -</div> -</div> -<div class="sect1"> +<p>Gun is designed with the HTTP/2 and Websocket protocols in mind. They are built for long-running connections that allow concurrent exchange of data, either in the form of request/responses for HTTP/2 or in the form of messages for Websocket.</p> +<p>A Gun connection is an Erlang process that manages a socket to a remote endpoint. This Gun connection is owned by a user process that is called the <em>owner</em> of the connection, and is managed by the supervision tree of the <code>gun</code> application.</p> +<p>The owner process communicates with the Gun connection by calling functions from the module <code>gun</code>. All functions perform their respective operations asynchronously. The Gun connection will send Erlang messages to the owner process whenever needed.</p> +<p>When the remote endpoint closes the connection, Gun attempts to reconnect automatically.</p> <h2 id="_opening_a_new_connection">Opening a new connection</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>gun:open/2,3</code> function must be used to open a connection.</p></div> -<div class="listingblock"> -<div class="title">Opening a connection to example.org on port 443</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>The <code>gun:open/2,3</code> function must be used to open a connection.</p> +<div class="listingblock"><div class="title">Opening a connection to example.org on port 443</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">443</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>If the port given is 443, Gun will attempt to connect using -TLS. The protocol will be selected automatically using the -ALPN extension for TLS. By default Gun supports HTTP/2 -and HTTP/1.1 when connecting using TLS.</p></div> -<div class="paragraph"><p>For any other port, Gun will attempt to connect using -plain TCP and will use the HTTP/1.1 protocol.</p></div> -<div class="paragraph"><p>The transport and protocol used can be overriden via -options. The manual documents all available options.</p></div> -<div class="paragraph"><p>Options can be provided as a third argument, and take the -form of a map.</p></div> -<div class="listingblock"> -<div class="title">Opening a TLS connection to example.org on port 8443</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>If the port given is 443, Gun will attempt to connect using TLS. The protocol will be selected automatically using the ALPN extension for TLS. By default Gun supports HTTP/2 and HTTP/1.1 when connecting using TLS.</p> +<p>For any other port, Gun will attempt to connect using plain TCP and will use the HTTP/1.1 protocol.</p> +<p>The transport and protocol used can be overriden via options. The manual documents all available options.</p> +<p>Options can be provided as a third argument, and take the form of a map.</p> +<div class="listingblock"><div class="title">Opening a TLS connection to example.org on port 8443</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">8443</span>, #{<span style="color: #0000FF">transport</span> <span style="color: #990000">=></span> <span style="color: #FF6600">tls</span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">8443</font>, #{<font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tls</font>})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_waiting_for_the_connection_to_be_established">Waiting for the connection to be established</h2> -<div class="sectionbody"> -<div class="paragraph"><p>When Gun successfully connects to the server, it sends a -<code>gun_up</code> message with the protocol that has been selected -for the connection.</p></div> -<div class="paragraph"><p>Gun provides the functions <code>gun:await_up/1,2,3</code> that wait -for the <code>gun_up</code> message. They can optionally take a monitor -reference and/or timeout value. If no monitor is provided, -one will be created for the duration of the function call.</p></div> -<div class="listingblock"> -<div class="title">Synchronous opening of a connection</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>When Gun successfully connects to the server, it sends a <code>gun_up</code> message with the protocol that has been selected for the connection.</p> +<p>Gun provides the functions <code>gun:await_up/1,2,3</code> that wait for the <code>gun_up</code> message. They can optionally take a monitor reference and/or timeout value. If no monitor is provided, one will be created for the duration of the function call.</p> +<div class="listingblock"><div class="title">Synchronous opening of a connection</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">443</span>), -{<span style="color: #FF6600">ok</span>, <span style="color: #009900">Protocol</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await_up</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>), +{<font color="#FF6600">ok</font>, <font color="#009900">Protocol</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_handling_connection_loss">Handling connection loss</h2> -<div class="sectionbody"> -<div class="paragraph"><p>When the connection is lost, Gun will send a <code>gun_down</code> -message indicating the current protocol, the reason the -connection was lost and two lists of stream references.</p></div> -<div class="paragraph"><p>The first list indicates open streams that <em>may</em> have been -processed by the server. The second list indicates open -streams that the server did not process.</p></div> -</div> -</div> -<div class="sect1"> +<p>When the connection is lost, Gun will send a <code>gun_down</code> message indicating the current protocol, the reason the connection was lost and two lists of stream references.</p> +<p>The first list indicates open streams that <em>may</em> have been processed by the server. The second list indicates open streams that the server did not process.</p> <h2 id="_monitoring_the_connection_process">Monitoring the connection process</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Because software errors are unavoidable, it is important to -detect when the Gun process crashes. It is also important -to detect when it exits normally. Erlang provides two ways -to do that: links and monitors.</p></div> -<div class="paragraph"><p>Gun leaves you the choice as to which one will be used. -However, if you use the <code>gun:await/2,3</code> or <code>gun:await_body/2,3</code> -functions, a monitor may be used for you to avoid getting -stuck waiting for a message that will never come.</p></div> -<div class="paragraph"><p>If you choose to monitor yourself you can do it on a permanent -basis rather than on every message you will receive, saving -resources. Indeed, the <code>gun:await/3,4</code> and <code>gun:await_body/3,4</code> -functions both accept a monitor argument if you have one already.</p></div> -<div class="listingblock"> -<div class="title">Monitoring the connection process</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Because software errors are unavoidable, it is important to detect when the Gun process crashes. It is also important to detect when it exits normally. Erlang provides two ways to do that: links and monitors.</p> +<p>Gun leaves you the choice as to which one will be used. However, if you use the <code>gun:await/2,3</code> or <code>gun:await_body/2,3</code> functions, a monitor may be used for you to avoid getting stuck waiting for a message that will never come.</p> +<p>If you choose to monitor yourself you can do it on a permanent basis rather than on every message you will receive, saving resources. Indeed, the <code>gun:await/3,4</code> and <code>gun:await_body/3,4</code> functions both accept a monitor argument if you have one already.</p> +<div class="listingblock"><div class="title">Monitoring the connection process</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">443</span>)<span style="color: #990000">.</span> -<span style="color: #009900">MRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">monitor</span></span>(<span style="font-weight: bold"><span style="color: #000080">process</span></span>, <span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>This monitor reference can be kept and used until the connection -process exits.</p></div> -<div class="listingblock"> -<div class="title">Handling <code>DOWN</code> messages</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font> +<font color="#009900">MRef</font> <font color="#990000">=</font> <b><font color="#000000">monitor</font></b>(<b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>This monitor reference can be kept and used until the connection process exits.</p> +<div class="listingblock"><div class="title">Handling `DOWN` messages</div> +<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: #0000FF">receive</span></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Receive Gun messages here...</span></span> - {<span style="color: #FF6600">'DOWN'</span>, <span style="color: #009900">Mref</span>, <span style="font-weight: bold"><span style="color: #000080">process</span></span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Reason</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">error_logger:error_msg</span></span>(<span style="color: #FF0000">"Oops!"</span>), - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>(<span style="color: #009900">Reason</span>) -<span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>What to do when you receive a <code>DOWN</code> message is entirely up to you.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#0000FF">receive</font></b> + <i><font color="#9A1900">%% Receive Gun messages here...</font></i> + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">Mref</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>What to do when you receive a <code>DOWN</code> message is entirely up to you.</p> <h2 id="_closing_the_connection_abruptly">Closing the connection abruptly</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The connection can be stopped abruptly at any time by calling -the <code>gun:close/1</code> function.</p></div> -<div class="listingblock"> -<div class="title">Immediate closing of the connection</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>The connection can be stopped abruptly at any time by calling the <code>gun:close/1</code> function.</p> +<div class="listingblock"><div class="title">Immediate closing of the connection</div> +<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">gun:close</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>The process is stopped immediately without having a chance to -perform the protocol’s closing handshake, if any.</p></div> -</div> -</div> +<pre><tt><b><font color="#000000">gun:close</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The process is stopped immediately without having a chance to perform the protocol's closing handshake, if any.</p> +<!-- === Closing the connection gracefully--> +<!-- --> +<!-- The connection can also be stopped gracefully by calling the--> +<!-- `gun:shutdown/1` function.--> +<!-- --> +<!-- .Graceful shutdown of the connection--> +<!-- [source,erlang]--> +<!-- ------> +<!-- gun:shutdown(ConnPid).--> +<!-- ------> +<!-- --> +<!-- Gun will refuse any new requests or messages after you call--> +<!-- this function. It will however continue to send you messages--> +<!-- for existing streams until they are all completed.--> +<!-- --> +<!-- For example if you performed a GET request just before calling--> +<!-- `gun:shutdown/1`, you will still receive the response before--> +<!-- Gun closes the connection.--> +<!-- --> +<!-- If you set a monitor beforehand, you will receive a message--> +<!-- when the connection has been closed.--> + diff --git a/docs/en/gun/1.0/guide/http/index.html b/docs/en/gun/1.0/guide/http/index.html index 6c32ab5d..0d132edc 100644 --- a/docs/en/gun/1.0/guide/http/index.html +++ b/docs/en/gun/1.0/guide/http/index.html @@ -62,395 +62,279 @@ <h1 class="lined-header"><span>HTTP</span></h1> -<div class="paragraph"><p>This chapter describes how to use the Gun client for -communicating with an HTTP/1.1 or HTTP/2 server.</p></div> -<div class="sect1"> +<p>This chapter describes how to use the Gun client for communicating with an HTTP/1.1 or HTTP/2 server.</p> <h2 id="_streams">Streams</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Every time a request is initiated, Gun creates a <em>stream</em>. -A <em>stream reference</em> uniquely identifies a set of request and -response and must be used to perform additional operations -with a stream or to identify its messages.</p></div> -<div class="paragraph"><p>Stream references use the Erlang <em>reference</em> data type and -are therefore unique.</p></div> -<div class="paragraph"><p>Streams can be canceled at any time. This will stop any further -messages from being sent to the owner process. Depending on -its capabilities, the server will also be instructed to cancel -the request.</p></div> -<div class="paragraph"><p>Canceling a stream may result in Gun dropping the connection -temporarily, to avoid uploading or downloading data that will -not be used.</p></div> -<div class="listingblock"> -<div class="title">Cancelling a stream</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Every time a request is initiated, Gun creates a <em>stream</em>. A <em>stream reference</em> uniquely identifies a set of request and response and must be used to perform additional operations with a stream or to identify its messages.</p> +<p>Stream references use the Erlang <em>reference</em> data type and are therefore unique.</p> +<p>Streams can be canceled at any time. This will stop any further messages from being sent to the owner process. Depending on its capabilities, the server will also be instructed to cancel the request.</p> +<p>Canceling a stream may result in Gun dropping the connection temporarily, to avoid uploading or downloading data that will not be used.</p> +<div class="listingblock"><div class="title">Cancelling a stream</div> +<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">gun:cancel</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_sending_requests">Sending requests</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun provides many convenient functions for performing common -operations, like GET, POST or DELETE. It also provides a -general purpose function in case you need other methods.</p></div> -<div class="paragraph"><p>The availability of these methods on the server can vary -depending on the software used but also on a per-resource -basis.</p></div> -<div class="paragraph"><p>Gun will automatically set a few headers depending on the -method used. For all methods however it will set the host -header if it has not been provided in the request arguments.</p></div> -<div class="paragraph"><p>This section focuses on the act of sending a request. The -handling of responses will be explained further on.</p></div> -<div class="sect3"> +<p>Gun provides many convenient functions for performing common operations, like GET, POST or DELETE. It also provides a general purpose function in case you need other methods.</p> +<p>The availability of these methods on the server can vary depending on the software used but also on a per-resource basis.</p> +<p>Gun will automatically set a few headers depending on the method used. For all methods however it will set the host header if it has not been provided in the request arguments.</p> +<p>This section focuses on the act of sending a request. The handling of responses will be explained further on.</p> <h4 id="_get_and_head">GET and HEAD</h4> -<div class="paragraph"><p>Use <code>gun:get/2,3,4</code> to request a resource.</p></div> -<div class="listingblock"> -<div class="title">GET "/organizations/ninenines"</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Use <code>gun:get/2,3,4</code> to request a resource.</p> +<div class="listingblock"><div class="title">GET "/organizations/ninenines"</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">GET "/organizations/ninenines" with custom headers</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">GET "/organizations/ninenines" with custom headers</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"application/json"</span>}, - {<span style="color: #990000"><<</span><span style="color: #FF0000">"user-agent"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"revolver/1.0"</span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>Note that the list of headers has the field name as a binary. -The field value is iodata, which is either a binary or an -iolist.</p></div> -<div class="paragraph"><p>Use <code>gun:head/2,3,4</code> if you don’t need the response body.</p></div> -<div class="listingblock"> -<div class="title">HEAD "/organizations/ninenines"</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>Note that the list of headers has the field name as a binary. The field value is iodata, which is either a binary or an iolist.</p> +<p>Use <code>gun:head/2,3,4</code> if you don't need the response body.</p> +<div class="listingblock"><div class="title">HEAD "/organizations/ninenines"</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">HEAD "/organizations/ninenines" with custom headers</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">HEAD "/organizations/ninenines" with custom headers</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"application/json"</span>}, - {<span style="color: #990000"><<</span><span style="color: #FF0000">"user-agent"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"revolver/1.0"</span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>It is not possible to send a request body with a GET or HEAD -request.</p></div> -</div> -<div class="sect3"> -<h4 id="_post_put_and_patch">POST, PUT and PATCH</h4> -<div class="paragraph"><p>HTTP defines three methods to create or update a resource.</p></div> -<div class="paragraph"><p>POST is generally used when the resource identifier (URI) isn’t known -in advance when creating a resource. POST can also be used to -replace an existing resource, although PUT is more appropriate -in that situation.</p></div> -<div class="paragraph"><p>PUT creates or replaces a resource identified by the URI.</p></div> -<div class="paragraph"><p>PATCH provides instructions on how to modify the resource.</p></div> -<div class="paragraph"><p>Both POST and PUT send the entire resource representation in their -request body. The PATCH method can be used when this is not -desirable. The request body of a PATCH method may be a partial -representation or a list of instructions on how to update the -resource.</p></div> -<div class="paragraph"><p>The <code>gun:post/4,5</code>, <code>gun:put/4,5</code> and <code>gun:patch/4,5</code> functions -take a body as their fourth argument. These functions do -not require any body-specific header to be set, although -it is always recommended to set the content-type header. -Gun will set the other headers automatically.</p></div> -<div class="paragraph"><p>In this and the following examples in this section, <code>gun:post</code> -can be replaced by <code>gun:put</code> or <code>gun:patch</code> for performing -a PUT or PATCH request, respectively.</p></div> -<div class="listingblock"> -<div class="title">POST "/organizations/ninenines"</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>}, + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>It is not possible to send a request body with a GET or HEAD request.</p> +<h4 id="_post__put_and_patch">POST, PUT and PATCH</h4> +<p>HTTP defines three methods to create or update a resource.</p> +<p>POST is generally used when the resource identifier (URI) isn't known in advance when creating a resource. POST can also be used to replace an existing resource, although PUT is more appropriate in that situation.</p> +<p>PUT creates or replaces a resource identified by the URI.</p> +<p>PATCH provides instructions on how to modify the resource.</p> +<p>Both POST and PUT send the entire resource representation in their request body. The PATCH method can be used when this is not desirable. The request body of a PATCH method may be a partial representation or a list of instructions on how to update the resource.</p> +<p>The <code>gun:post/4,5</code>, <code>gun:put/4,5</code> and <code>gun:patch/4,5</code> functions take a body as their fourth argument. These functions do not require any body-specific header to be set, although it is always recommended to set the content-type header. Gun will set the other headers automatically.</p> +<p>In this and the following examples in this section, <code>gun:post</code> can be replaced by <code>gun:put</code> or <code>gun:patch</code> for performing a PUT or PATCH request, respectively.</p> +<div class="listingblock"><div class="title">POST "/organizations/ninenines"</div> +<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="color: #009900">Body</span> <span style="color: #990000">=</span> <span style="color: #FF0000">"{\"msg\": \"Hello world!\"}"</span>, -<span style="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"application/json"</span>} -], <span style="color: #009900">Body</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>The <code>gun:post/3</code>, <code>gun:put/3</code> and <code>gun:patch/3</code> functions -do not take a body in their arguments. If a body is to be -provided later on, using the <code>gun:data/4</code> function, then -the request headers must indicate this. This can be done -by setting the content-length or content-type request -headers. If these headers are not set then Gun will assume -the request has no body.</p></div> -<div class="paragraph"><p>It is recommended to send the content-length header if you -know it in advance, although this is not required. If it -is not set, HTTP/1.1 will use the chunked transfer-encoding, -and HTTP/2 will continue normally as it is chunked by design.</p></div> -<div class="listingblock"> -<div class="title">POST "/organizations/ninenines" with delayed body</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">Body</font> <font color="#990000">=</font> <font color="#FF0000">"{\"msg\": \"Hello world!\"}"</font>, +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>} +], <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>gun:post/3</code>, <code>gun:put/3</code> and <code>gun:patch/3</code> functions do not take a body in their arguments. If a body is to be provided later on, using the <code>gun:data/4</code> function, then the request headers must indicate this. This can be done by setting the content-length or content-type request headers. If these headers are not set then Gun will assume the request has no body.</p> +<p>It is recommended to send the content-length header if you know it in advance, although this is not required. If it is not set, HTTP/1.1 will use the chunked transfer-encoding, and HTTP/2 will continue normally as it is chunked by design.</p> +<div class="listingblock"><div class="title">POST "/organizations/ninenines" with delayed body</div> +<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="color: #009900">Body</span> <span style="color: #990000">=</span> <span style="color: #FF0000">"{\"msg\": \"Hello world!\"}"</span>, -<span style="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-length"</span><span style="color: #990000">>></span>, <span style="font-weight: bold"><span style="color: #000000">integer_to_binary</span></span>(<span style="font-weight: bold"><span style="color: #000080">length</span></span>(<span style="color: #009900">Body</span>))}, - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"application/json"</span>} +<pre><tt><font color="#009900">Body</font> <font color="#990000">=</font> <font color="#FF0000">"{\"msg\": \"Hello world!\"}"</font>, +<font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-length"</font><font color="#990000">>></font>, <b><font color="#000000">integer_to_binary</font></b>(<b><font color="#000080">length</font></b>(<font color="#009900">Body</font>))}, + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#FF0000">"application/json"</font>} ]), -<span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #009900">Body</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>The atom <code>fin</code> indicates this is the last chunk of data to -be sent. You can call the <code>gun:data/4</code> function as many -times as needed until you have sent the entire body. The -last call must use <code>fin</code> and all the previous calls must -use <code>nofin</code>. The last chunk may be empty.</p></div> -<div class="listingblock"> -<div class="title">Streaming the request body</div> -<div class="content"><!-- Generator: GNU source-highlight +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Body</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The atom <code>fin</code> indicates this is the last chunk of data to be sent. You can call the <code>gun:data/4</code> function as many times as needed until you have sent the entire body. The last call must use <code>fin</code> and all the previous calls must use <code>nofin</code>. The last chunk may be empty.</p> +<div class="listingblock"><div class="title">Streaming the request body</div> +<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">sendfile</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Filepath</span>) <span style="color: #990000">-></span> - {<span style="color: #FF6600">ok</span>, <span style="color: #009900">IoDevice</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">file:open</span></span>(<span style="color: #009900">Filepath</span>, [<span style="color: #FF6600">read</span>, <span style="font-weight: bold"><span style="color: #000080">binary</span></span>, <span style="color: #FF6600">raw</span>]), - <span style="font-weight: bold"><span style="color: #000000">do_sendfile</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">IoDevice</span>)<span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000000">do_sendfile</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">IoDevice</span>) <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #0000FF">case</span></span> <span style="font-weight: bold"><span style="color: #000000">file:read</span></span>(<span style="color: #009900">IoDevice</span>, <span style="color: #993399">8000</span>) <span style="font-weight: bold"><span style="color: #0000FF">of</span></span> - <span style="color: #FF6600">eof</span> <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #990000"><<>></span>), - <span style="font-weight: bold"><span style="color: #000000">file:close</span></span>(<span style="color: #009900">IoDevice</span>); - {<span style="color: #FF6600">ok</span>, <span style="color: #009900">Bin</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #009900">Bin</span>), - <span style="font-weight: bold"><span style="color: #000000">do_sendfile</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">IoDevice</span>) - <span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -</div> -<div class="sect3"> +<pre><tt><b><font color="#000000">sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Filepath</font>) <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">IoDevice</font>} <font color="#990000">=</font> <b><font color="#000000">file:open</font></b>(<font color="#009900">Filepath</font>, [<font color="#FF6600">read</font>, <b><font color="#000080">binary</font></b>, <font color="#FF6600">raw</font>]), + <b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>)<font color="#990000">.</font> + +<b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>) <font color="#990000">-></font> + <b><font color="#0000FF">case</font></b> <b><font color="#000000">file:read</font></b>(<font color="#009900">IoDevice</font>, <font color="#993399">8000</font>) <b><font color="#0000FF">of</font></b> + <font color="#FF6600">eof</font> <font color="#990000">-></font> + <b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<>></font>), + <b><font color="#000000">file:close</font></b>(<font color="#009900">IoDevice</font>); + {<font color="#FF6600">ok</font>, <font color="#009900">Bin</font>} <font color="#990000">-></font> + <b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Bin</font>), + <b><font color="#000000">do_sendfile</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IoDevice</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> <h4 id="_delete">DELETE</h4> -<div class="paragraph"><p>Use <code>gun:delete/2,3,4</code> to delete a resource.</p></div> -<div class="listingblock"> -<div class="title">DELETE "/organizations/ninenines"</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Use <code>gun:delete/2,3,4</code> to delete a resource.</p> +<div class="listingblock"><div class="title">DELETE "/organizations/ninenines"</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">DELETE "/organizations/ninenines" with custom headers</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">DELETE "/organizations/ninenines" with custom headers</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"user-agent"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"revolver/1.0"</span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -</div> -<div class="sect3"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> <h4 id="_options">OPTIONS</h4> -<div class="paragraph"><p>Use <code>gun:options/2,3</code> to request information about a resource.</p></div> -<div class="listingblock"> -<div class="title">OPTIONS "/organizations/ninenines"</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Use <code>gun:options/2,3</code> to request information about a resource.</p> +<div class="listingblock"><div class="title">OPTIONS "/organizations/ninenines"</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">OPTIONS "/organizations/ninenines" with custom headers</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">OPTIONS "/organizations/ninenines" with custom headers</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"user-agent"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"revolver/1.0"</span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>You can also use this function to request information about -the server itself.</p></div> -<div class="listingblock"> -<div class="title">OPTIONS "*"</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"user-agent"</font><font color="#990000">>></font>, <font color="#FF0000">"revolver/1.0"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can also use this function to request information about the server itself.</p> +<div class="listingblock"><div class="title">OPTIONS "*"</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"*"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -<div class="sect3"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"*"</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h4 id="_requests_with_an_arbitrary_method">Requests with an arbitrary method</h4> -<div class="paragraph"><p>The <code>gun:request/4,5,6</code> function can be used to send requests -with a configurable method name. It is mostly useful when you -need a method that Gun does not understand natively.</p></div> -<div class="listingblock"> -<div class="title">Example of a TRACE request</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>The <code>gun:request/4,5,6</code> function can be used to send requests with a configurable method name. It is mostly useful when you need a method that Gun does not understand natively.</p> +<div class="listingblock"><div class="title">Example of a TRACE request</div> +<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">gun:request</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"TRACE"</span>, <span style="color: #FF0000">"/"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"max-forwards"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"30"</span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:request</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"TRACE"</font>, <font color="#FF0000">"/"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"max-forwards"</font><font color="#990000">>></font>, <font color="#FF0000">"30"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_processing_responses">Processing responses</h2> -<div class="sectionbody"> -<div class="paragraph"><p>All data received from the server is sent to the owner -process as a message. First a <code>gun_response</code> message is sent, -followed by zero or more <code>gun_data</code> messages. If something goes wrong, -a <code>gun_error</code> message is sent instead.</p></div> -<div class="paragraph"><p>The response message will inform you whether there will be -data messages following. If it contains <code>fin</code> there will be -no data messages. If it contains <code>nofin</code> then one or more data -messages will follow.</p></div> -<div class="paragraph"><p>When using HTTP/2 this value is sent with the frame and simply -passed on in the message. When using HTTP/1.1 however Gun must -guess whether data will follow by looking at the response headers.</p></div> -<div class="paragraph"><p>You can receive messages directly, or you can use the <em>await</em> -functions to let Gun receive them for you.</p></div> -<div class="listingblock"> -<div class="title">Receiving a response using receive</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>All data received from the server is sent to the owner process as a message. First a <code>gun_response</code> message is sent, followed by zero or more <code>gun_data</code> messages. If something goes wrong, a <code>gun_error</code> message is sent instead.</p> +<p>The response message will inform you whether there will be data messages following. If it contains <code>fin</code> there will be no data messages. If it contains <code>nofin</code> then one or more data messages will follow.</p> +<p>When using HTTP/2 this value is sent with the frame and simply passed on in the message. When using HTTP/1.1 however Gun must guess whether data will follow by looking at the response headers.</p> +<p>You can receive messages directly, or you can use the <em>await</em> functions to let Gun receive them for you.</p> +<div class="listingblock"><div class="title">Receiving a response using receive</div> +<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">print_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">MRef</span>) <span style="color: #990000">-></span> - <span style="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/"</span>), - <span style="font-weight: bold"><span style="color: #0000FF">receive</span></span> - {<span style="color: #FF6600">gun_response</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - <span style="color: #FF6600">no_data</span>; - {<span style="color: #FF6600">gun_response</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">receive_data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">MRef</span>, <span style="color: #009900">StreamRef</span>); - {<span style="color: #FF6600">'DOWN'</span>, <span style="color: #009900">MRef</span>, <span style="font-weight: bold"><span style="color: #000080">process</span></span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Reason</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">error_logger:error_msg</span></span>(<span style="color: #FF0000">"Oops!"</span>), - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>(<span style="color: #009900">Reason</span>) - <span style="font-weight: bold"><span style="color: #0000FF">after</span></span> <span style="color: #993399">1000</span> <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>(<span style="color: #FF6600">timeout</span>) - <span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000000">receive_data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">MRef</span>, <span style="color: #009900">StreamRef</span>) <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #0000FF">receive</span></span> - {<span style="color: #FF6600">gun_data</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #009900">Data</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">io:format</span></span>(<span style="color: #FF0000">"~s~n"</span>, [<span style="color: #009900">Data</span>]), - <span style="font-weight: bold"><span style="color: #000000">receive_data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">MRef</span>, <span style="color: #009900">StreamRef</span>); - {<span style="color: #FF6600">gun_data</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #009900">Data</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">io:format</span></span>(<span style="color: #FF0000">"~s~n"</span>, [<span style="color: #009900">Data</span>]); - {<span style="color: #FF6600">'DOWN'</span>, <span style="color: #009900">MRef</span>, <span style="font-weight: bold"><span style="color: #000080">process</span></span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Reason</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">error_logger:error_msg</span></span>(<span style="color: #FF0000">"Oops!"</span>), - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>(<span style="color: #009900">Reason</span>) - <span style="font-weight: bold"><span style="color: #0000FF">after</span></span> <span style="color: #993399">1000</span> <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>(<span style="color: #FF6600">timeout</span>) - <span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>While it may seem verbose, using messages like this has the -advantage of never locking your process, allowing you to -easily debug your code. It also allows you to start more than -one connection and concurrently perform queries on all of them -at the same time.</p></div> -<div class="paragraph"><p>You can also use Gun in a synchronous manner by using the <em>await</em> -functions.</p></div> -<div class="paragraph"><p>The <code>gun:await/2,3,4</code> function will wait until it receives -a response to, a pushed resource related to, or data from -the given stream.</p></div> -<div class="paragraph"><p>When calling <code>gun:await/2,3</code> and not passing a monitor -reference, one is automatically created for you for the -duration of the call.</p></div> -<div class="paragraph"><p>The <code>gun:await_body/2,3,4</code> works similarly, but returns the -body received. Both functions can be combined to receive the -response and its body sequentially.</p></div> -<div class="listingblock"> -<div class="title">Receiving a response using await</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#000000">print_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>) <font color="#990000">-></font> + <font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/"</font>), + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <font color="#FF6600">no_data</font>; + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">MRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) + <b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font> + +<b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> + <b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Data</font>]), + <b><font color="#000000">receive_data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MRef</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#009900">Data</font>} <font color="#990000">-></font> + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Data</font>]); + {<font color="#FF6600">'DOWN'</font>, <font color="#009900">MRef</font>, <b><font color="#000080">process</font></b>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000000">error_logger:error_msg</font></b>(<font color="#FF0000">"Oops!"</font>), + <b><font color="#000080">exit</font></b>(<font color="#009900">Reason</font>) + <b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) + <b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>While it may seem verbose, using messages like this has the advantage of never locking your process, allowing you to easily debug your code. It also allows you to start more than one connection and concurrently perform queries on all of them at the same time.</p> +<p>You can also use Gun in a synchronous manner by using the <em>await</em> functions.</p> +<p>The <code>gun:await/2,3,4</code> function will wait until it receives a response to, a pushed resource related to, or data from the given stream.</p> +<p>When calling <code>gun:await/2,3</code> and not passing a monitor reference, one is automatically created for you for the duration of the call.</p> +<p>The <code>gun:await_body/2,3,4</code> works similarly, but returns the body received. Both functions can be combined to receive the response and its body sequentially.</p> +<div class="listingblock"><div class="title">Receiving a response using await</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/"</span>), -<span style="font-weight: bold"><span style="color: #0000FF">case</span></span> <span style="font-weight: bold"><span style="color: #000000">gun:await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>) <span style="font-weight: bold"><span style="color: #0000FF">of</span></span> - {<span style="color: #FF6600">response</span>, <span style="color: #FF6600">fin</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - <span style="color: #FF6600">no_data</span>; - {<span style="color: #FF6600">response</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - {<span style="color: #FF6600">ok</span>, <span style="color: #009900">Body</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>), - <span style="font-weight: bold"><span style="color: #000000">io:format</span></span>(<span style="color: #FF0000">"~s~n"</span>, [<span style="color: #009900">Body</span>]) -<span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/"</font>), +<b><font color="#0000FF">case</font></b> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <b><font color="#0000FF">of</font></b> + {<font color="#FF6600">response</font>, <font color="#FF6600">fin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <font color="#FF6600">no_data</font>; + {<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>), + <b><font color="#000000">io:format</font></b>(<font color="#FF0000">"~s~n"</font>, [<font color="#009900">Body</font>]) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_handling_streams_pushed_by_the_server">Handling streams pushed by the server</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The HTTP/2 protocol allows the server to push more than one -resource for every request. It will start sending those -extra resources before it starts sending the response itself, -so Gun will send you <code>gun_push</code> messages before <code>gun_response</code> -when that happens.</p></div> -<div class="paragraph"><p>You can safely choose to ignore <code>gun_push</code> messages, or -you can handle them. If you do, you can either receive the -messages directly or use <em>await</em> functions.</p></div> -<div class="paragraph"><p>The <code>gun_push</code> message contains both the new stream reference -and the stream reference of the original request.</p></div> -<div class="listingblock"> -<div class="title">Receiving a pushed response using receive</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>The HTTP/2 protocol allows the server to push more than one resource for every request. It will start sending those extra resources before it starts sending the response itself, so Gun will send you <code>gun_push</code> messages before <code>gun_response</code> when that happens.</p> +<p>You can safely choose to ignore <code>gun_push</code> messages, or you can handle them. If you do, you can either receive the messages directly or use <em>await</em> functions.</p> +<p>The <code>gun_push</code> message contains both the new stream reference and the stream reference of the original request.</p> +<div class="listingblock"><div class="title">Receiving a pushed response using receive</div> +<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: #0000FF">receive</span></span> - {<span style="color: #FF6600">gun_push</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">OriginalStreamRef</span>, <span style="color: #009900">PushedStreamRef</span>, - <span style="color: #009900">Method</span>, <span style="color: #009900">Host</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">enjoy</span></span>() -<span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>If you use the <code>gun:await/2,3,4</code> function, however, Gun -will use the original reference to identify the message but -will return a tuple that doesn’t contain it.</p></div> -<div class="listingblock"> -<div class="title">Receiving a pushed response using await</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">OriginalStreamRef</font>, <font color="#009900">PushedStreamRef</font>, + <font color="#009900">Method</font>, <font color="#009900">Host</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">enjoy</font></b>() +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<p>If you use the <code>gun:await/2,3,4</code> function, however, Gun will use the original reference to identify the message but will return a tuple that doesn't contain it.</p> +<div class="listingblock"><div class="title">Receiving a pushed response using await</div> +<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="color: #FF6600">push</span>, <span style="color: #009900">PushedStreamRef</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">URI</span>, <span style="color: #009900">Headers</span>} - <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">OriginalStreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>The <code>PushedStreamRef</code> variable can then be used with <code>gun:await/2,3,4</code> -and <code>gun:await_body/2,3,4</code>.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">push</font>, <font color="#009900">PushedStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">OriginalStreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>The <code>PushedStreamRef</code> variable can then be used with <code>gun:await/2,3,4</code> and <code>gun:await_body/2,3,4</code>.</p> <h2 id="_flushing_unwanted_messages">Flushing unwanted messages</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun provides the function <code>gun:flush/1</code> to quickly get rid -of unwanted messages sitting in the process mailbox. You -can use it to get rid of all messages related to a connection, -or just the messages related to a stream.</p></div> -<div class="listingblock"> -<div class="title">Flush all messages from a Gun connection</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Gun provides the function <code>gun:flush/1</code> to quickly get rid of unwanted messages sitting in the process mailbox. You can use it to get rid of all messages related to a connection, or just the messages related to a stream.</p> +<div class="listingblock"><div class="title">Flush all messages from a Gun connection</div> +<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">gun:flush</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Flush all messages from a specific stream</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Flush all messages from a specific stream</div> +<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">gun:flush</span></span>(<span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_redirecting_responses_to_a_different_process">Redirecting responses to a different process</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun allows you to specify which process will handle responses -to a request via the <code>reply_to</code> request option.</p></div> -<div class="listingblock"> -<div class="title">GET "/organizations/ninenines" to a different process</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Gun allows you to specify which process will handle responses to a request via the <code>reply_to</code> request option.</p> +<div class="listingblock"><div class="title">GET "/organizations/ninenines" to a different process</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/organizations/ninenines"</span>, [], - #{<span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">Pid</span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/organizations/ninenines"</font>, [], + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">Pid</font>})<font color="#990000">.</font></tt></pre> +</div></div> + diff --git a/docs/en/gun/1.0/guide/index.html b/docs/en/gun/1.0/guide/index.html index cb30dd5b..78eff528 100644 --- a/docs/en/gun/1.0/guide/index.html +++ b/docs/en/gun/1.0/guide/index.html @@ -62,38 +62,20 @@ <h1 class="lined-header"><span>Gun User Guide</span></h1> -<div class="ulist"><ul> -<li> -<p> -<a href="introduction/">Introduction</a> -</p> +<ul><li><a href="introduction/">Introduction</a> </li> -<li> -<p> -<a href="start/">Starting and stopping</a> -</p> +<li><a href="start/">Starting and stopping</a> </li> -<li> -<p> -<a href="protocols/">Supported protocols</a> -</p> +<li><a href="protocols/">Supported protocols</a> </li> -<li> -<p> -<a href="connect/">Connection</a> -</p> +<li><a href="connect/">Connection</a> </li> -<li> -<p> -<a href="http/">Using HTTP</a> -</p> +<li><a href="http/">Using HTTP</a> </li> -<li> -<p> -<a href="websocket/">Using Websocket</a> -</p> +<li><a href="websocket/">Using Websocket</a> </li> -</ul></div> +</ul> + diff --git a/docs/en/gun/1.0/guide/introduction/index.html b/docs/en/gun/1.0/guide/introduction/index.html index 6a3ed2e7..c2f99ea1 100644 --- a/docs/en/gun/1.0/guide/introduction/index.html +++ b/docs/en/gun/1.0/guide/introduction/index.html @@ -62,61 +62,35 @@ <h1 class="lined-header"><span>Introduction</span></h1> -<div class="paragraph"><p>Gun is an HTTP client for Erlang/OTP.</p></div> -<div class="paragraph"><p>Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols.</p></div> -<div class="sect1"> +<p>Gun is an HTTP client for Erlang/OTP.</p> +<p>Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols.</p> <h2 id="_prerequisites">Prerequisites</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket -protocols is required in order to read this guide.</p></div> -</div> -</div> -<div class="sect1"> +<p>Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket protocols is required in order to read this guide.</p> <h2 id="_supported_platforms">Supported platforms</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun is tested and supported on Linux, FreeBSD, Windows and OSX.</p></div> -<div class="paragraph"><p>Gun is developed for Erlang/OTP 19.0 and newer.</p></div> -</div> -</div> -<div class="sect1"> +<p>Gun is tested and supported on Linux, FreeBSD, Windows and OSX.</p> +<p>Gun is developed for Erlang/OTP 19.0 and newer.</p> <h2 id="_license">License</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun uses the ISC License.</p></div> -<div class="listingblock"> -<div class="content"> -<pre><code>Copyright (c) 2013-2018, Loïc Hoguin <[email protected]> +<p>Gun uses the ISC License.</p> +<div class="listingblock"><div class="content"><pre>Copyright (c) 2013-2018, Loïc Hoguin <[email protected]> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</code></pre> -</div></div> -</div> -</div> -<div class="sect1"> +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</pre></div></div> <h2 id="_versioning">Versioning</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun uses <a href="http://semver.org/">Semantic Versioning 2.0.0</a>.</p></div> -</div> -</div> -<div class="sect1"> +<p>Gun uses <a href="http://semver.org/">Semantic Versioning 2.0.0</a>.</p> <h2 id="_conventions">Conventions</h2> -<div class="sectionbody"> -<div class="paragraph"><p>In the HTTP protocol, the method name is case sensitive. All standard -method names are uppercase.</p></div> -<div class="paragraph"><p>Header names are case insensitive. Gun converts all the header names -to lowercase, and expects your application to provide lowercase header -names.</p></div> -<div class="paragraph"><p>The same applies to any other case insensitive value.</p></div> -</div> -</div> +<p>In the HTTP protocol, the method name is case sensitive. All standard method names are uppercase.</p> +<p>Header names are case insensitive. Gun converts all the header names to lowercase, and expects your application to provide lowercase header names.</p> +<p>The same applies to any other case insensitive value.</p> + diff --git a/docs/en/gun/1.0/guide/protocols/index.html b/docs/en/gun/1.0/guide/protocols/index.html index 00d70ad6..586ce865 100644 --- a/docs/en/gun/1.0/guide/protocols/index.html +++ b/docs/en/gun/1.0/guide/protocols/index.html @@ -62,270 +62,158 @@ <h1 class="lined-header"><span>Supported protocols</span></h1> -<div class="paragraph"><p>This chapter describes the protocols supported and the -operations available to them.</p></div> -<div class="sect1"> +<p>This chapter describes the protocols supported and the operations available to them.</p> <h2 id="_http_1_1">HTTP/1.1</h2> -<div class="sectionbody"> -<div class="paragraph"><p>HTTP/1.1 is a text request-response protocol. The client -sends a request, the server sends back a response.</p></div> -<div class="paragraph"><p>Gun provides convenience functions for performing GET, HEAD, -OPTIONS, POST, PATCH, PUT, and DELETE requests. All these -functions are aliases of <code>gun:request/4,5,6</code> for the respective -methods. Gun also provides a <code>gun:data/4</code> function for streaming -the request body.</p></div> -<div class="paragraph"><p>Gun will send a <code>gun_inform</code> message for every intermediate -informational responses received. They will always be sent -before the <code>gun_response</code> message.</p></div> -<div class="paragraph"><p>Gun will send a <code>gun_response</code> message for every response -received, followed by zero or more <code>gun_data</code> messages for -the response body, which is optionally terminated by a -<code>gun_trailers</code> message. If something goes wrong, a <code>gun_error</code> -will be sent instead.</p></div> -<div class="paragraph"><p>Gun provides convenience functions for dealing with messages. -The <code>gun:await/2,3,4</code> function waits for a response to the given -request, and the <code>gun:await_body/2,3,4</code> function for the -response body. The <code>gun:flush/1</code> function can be used to clear all -messages related to a request or a connection from the mailbox -of the calling process.</p></div> -<div class="paragraph"><p>The function <code>gun:cancel/2</code> can be used to silence the -response to a request previously sent if it is no longer -needed. When using HTTP/1.1 there is no multiplexing so -Gun will have to receive the response fully before any -other responses can be received.</p></div> -<div class="paragraph"><p>Finally, Gun can upgrade an HTTP/1.1 connection to Websocket. -It provides the <code>gun:ws_upgrade/2,3,4</code> function for that -purpose. A <code>gun_upgrade</code> message will be sent on success; -a <code>gun_response</code> message otherwise.</p></div> -</div> -</div> -<div class="sect1"> +<p>HTTP/1.1 is a text request-response protocol. The client sends a request, the server sends back a response.</p> +<p>Gun provides convenience functions for performing GET, HEAD, OPTIONS, POST, PATCH, PUT, and DELETE requests. All these functions are aliases of <code>gun:request/4,5,6</code> for the respective methods. Gun also provides a <code>gun:data/4</code> function for streaming the request body.</p> +<p>Gun will send a <code>gun_inform</code> message for every intermediate informational responses received. They will always be sent before the <code>gun_response</code> message.</p> +<p>Gun will send a <code>gun_response</code> message for every response received, followed by zero or more <code>gun_data</code> messages for the response body, which is optionally terminated by a <code>gun_trailers</code> message. If something goes wrong, a <code>gun_error</code> will be sent instead.</p> +<p>Gun provides convenience functions for dealing with messages. The <code>gun:await/2,3,4</code> function waits for a response to the given request, and the <code>gun:await_body/2,3,4</code> function for the response body. The <code>gun:flush/1</code> function can be used to clear all messages related to a request or a connection from the mailbox of the calling process.</p> +<p>The function <code>gun:cancel/2</code> can be used to silence the response to a request previously sent if it is no longer needed. When using HTTP/1.1 there is no multiplexing so Gun will have to receive the response fully before any other responses can be received.</p> +<p>Finally, Gun can upgrade an HTTP/1.1 connection to Websocket. It provides the <code>gun:ws_upgrade/2,3,4</code> function for that purpose. A <code>gun_upgrade</code> message will be sent on success; a <code>gun_response</code> message otherwise.</p> <h2 id="_http_2">HTTP/2</h2> -<div class="sectionbody"> -<div class="paragraph"><p>HTTP/2 is a binary protocol based on HTTP, compatible with -the HTTP semantics, that reduces the complexity of parsing -requests and responses, compresses the HTTP headers and -allows the server to push additional resources along with -the normal response to the original request.</p></div> -<div class="paragraph"><p>The HTTP/2 interface is very similar to HTTP/1.1, so this -section instead focuses on the differences in the interface -for the two protocols.</p></div> -<div class="paragraph"><p>Gun will send <code>gun_push</code> messages for every push received. -They will always be sent before the <code>gun_response</code> message. -They can be ignored safely if they are not needed, or they -can be canceled.</p></div> -<div class="paragraph"><p>The <code>gun:cancel/2</code> function will use the HTTP/2 stream -cancellation mechanism which allows Gun to inform the -server to stop sending a response for this particular -request, saving resources.</p></div> -<div class="paragraph"><p>It is not currently possible to upgrade an HTTP/2 connection -to Websocket. Support for this will be added in a future -release.</p></div> -</div> -</div> -<div class="sect1"> +<p>HTTP/2 is a binary protocol based on HTTP, compatible with the HTTP semantics, that reduces the complexity of parsing requests and responses, compresses the HTTP headers and allows the server to push additional resources along with the normal response to the original request.</p> +<p>The HTTP/2 interface is very similar to HTTP/1.1, so this section instead focuses on the differences in the interface for the two protocols.</p> +<p>Gun will send <code>gun_push</code> messages for every push received. They will always be sent before the <code>gun_response</code> message. They can be ignored safely if they are not needed, or they can be canceled.</p> +<p>The <code>gun:cancel/2</code> function will use the HTTP/2 stream cancellation mechanism which allows Gun to inform the server to stop sending a response for this particular request, saving resources.</p> +<p>It is not currently possible to upgrade an HTTP/2 connection to Websocket. Support for this will be added in a future release.</p> <h2 id="_websocket">Websocket</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Websocket is a binary protocol built on top of HTTP that -allows asynchronous concurrent communication between the -client and the server. A Websocket server can push data to -the client at any time.</p></div> -<div class="paragraph"><p>Websocket is only available as a connection upgrade over -an HTTP/1.1 connection.</p></div> -<div class="paragraph"><p>Once the Websocket connection is established, the only -operation available on this connection is sending Websocket -frames using <code>gun:ws_send/2</code>.</p></div> -<div class="paragraph"><p>Gun will send a <code>gun_ws</code> message for every frame received.</p></div> -</div> -</div> -<div class="sect1"> +<p>Websocket is a binary protocol built on top of HTTP that allows asynchronous concurrent communication between the client and the server. A Websocket server can push data to the client at any time.</p> +<p>Websocket is only available as a connection upgrade over an HTTP/1.1 connection.</p> +<p>Once the Websocket connection is established, the only operation available on this connection is sending Websocket frames using <code>gun:ws_send/2</code>.</p> +<p>Gun will send a <code>gun_ws</code> message for every frame received.</p> <h2 id="_summary">Summary</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The two following tables summarize the supported operations -and the messages Gun sends depending on the connection’s -current protocol.</p></div> -<div class="tableblock"> -<table rules="all" -width="100%" -frame="border" -cellspacing="0" cellpadding="4"> -<col width="25%" /> -<col width="25%" /> -<col width="25%" /> -<col width="25%" /> -<thead> -<tr> -<th align="left" valign="top"> Operation </th> -<th align="center" valign="top"> HTTP/1.1 </th> -<th align="center" valign="top"> HTTP/2 </th> -<th align="center" valign="top"> Websocket</th> +<p>The two following tables summarize the supported operations and the messages Gun sends depending on the connection's current protocol.</p> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<caption>Supported operations per protocol</caption><thead><tr><th>Operation</th> +<th>HTTP/1.1</th> +<th>HTTP/2</th> +<th>Websocket</th> +</tr></thead><tbody><tr><td>delete</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -</thead> -<tbody> -<tr> -<td align="left" valign="top"><p class="table">delete</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>get</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">get</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>head</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">head</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>options</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">options</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>patch</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">patch</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>post</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">post</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>put</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">put</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>request</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">request</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>data</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">data</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>await</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">await</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>await_body</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">await_body</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>flush</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">flush</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>cancel</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">cancel</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>ws_upgrade</td> +<td>yes</td> +<td>no</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">ws_upgrade</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>ws_send</td> +<td>no</td> +<td>no</td> +<td>yes</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">ws_send</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> +</tbody></table> +<table rules="all" width="100%" frame="border" + cellspacing="0" cellpadding="4"> +<caption>Messages sent per protocol</caption><thead><tr><th>Message</th> +<th>HTTP/1.1</th> +<th>HTTP/2</th> +<th>Websocket</th> +</tr></thead><tbody><tr><td>gun_push</td> +<td>no</td> +<td>yes</td> +<td>no</td> </tr> -</tbody> -</table> -</div> -<div class="tableblock"> -<table rules="all" -width="100%" -frame="border" -cellspacing="0" cellpadding="4"> -<col width="25%" /> -<col width="25%" /> -<col width="25%" /> -<col width="25%" /> -<thead> -<tr> -<th align="left" valign="top"> Message </th> -<th align="center" valign="top"> HTTP/1.1 </th> -<th align="center" valign="top"> HTTP/2 </th> -<th align="center" valign="top"> Websocket</th> +<tr><td>gun_inform</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -</thead> -<tbody> -<tr> -<td align="left" valign="top"><p class="table">gun_push</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>gun_response</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">gun_inform</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>gun_data</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">gun_response</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>gun_trailers</td> +<td>yes</td> +<td>yes</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">gun_data</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>gun_error</td> +<td>yes</td> +<td>yes</td> +<td>yes</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">gun_trailers</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> +<tr><td>gun_upgrade</td> +<td>yes</td> +<td>no</td> +<td>no</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">gun_error</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> +<tr><td>gun_ws</td> +<td>no</td> +<td>no</td> +<td>yes</td> </tr> -<tr> -<td align="left" valign="top"><p class="table">gun_upgrade</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -</tr> -<tr> -<td align="left" valign="top"><p class="table">gun_ws</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">no</p></td> -<td align="center" valign="top"><p class="table">yes</p></td> -</tr> -</tbody> -</table> -</div> -</div> -</div> +</tbody></table> + diff --git a/docs/en/gun/1.0/guide/start/index.html b/docs/en/gun/1.0/guide/start/index.html index 6611c3ea..8eda77a7 100644 --- a/docs/en/gun/1.0/guide/start/index.html +++ b/docs/en/gun/1.0/guide/start/index.html @@ -62,54 +62,37 @@ <h1 class="lined-header"><span>Starting and stopping</span></h1> -<div class="paragraph"><p>This chapter describes how to start and stop the Gun application.</p></div> -<div class="sect1"> +<p>This chapter describes how to start and stop the Gun application.</p> <h2 id="_setting_up">Setting up</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Specify Gun as a dependency to your application in your favorite -build tool.</p></div> -<div class="paragraph"><p>With Erlang.mk this is done by adding <code>gun</code> to the <code>DEPS</code> variable -in your Makefile.</p></div> -<div class="listingblock"> -<div class="title">Adding Gun as an Erlang.mk dependency</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Specify Gun as a dependency to your application in your favorite build tool.</p> +<p>With Erlang.mk this is done by adding <code>gun</code> to the <code>DEPS</code> variable in your Makefile.</p> +<div class="listingblock"><div class="title">Adding Gun as an Erlang.mk dependency</div> +<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="color: #009900">DEPS =</span> gun</tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">DEPS =</font> gun</tt></pre> +</div></div> <h2 id="_starting">Starting</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun is an <em>OTP application</em>. It needs to be started before you can -use it.</p></div> -<div class="listingblock"> -<div class="title">Starting Gun in an Erlang shell</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Gun is an <em>OTP application</em>. It needs to be started before you can use it.</p> +<div class="listingblock"><div class="title">Starting Gun in an Erlang shell</div> +<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="color: #993399">1</span><span style="color: #990000">></span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">gun</span>)<span style="color: #990000">.</span> -{<span style="color: #FF6600">ok</span>,[<span style="color: #FF6600">crypto</span>,<span style="color: #FF6600">cowlib</span>,<span style="color: #FF6600">asn1</span>,<span style="color: #FF6600">public_key</span>,<span style="color: #FF6600">ssl</span>,<span style="color: #FF6600">gun</span>]}</tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#993399">1</font><font color="#990000">></font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>,[<font color="#FF6600">crypto</font>,<font color="#FF6600">cowlib</font>,<font color="#FF6600">asn1</font>,<font color="#FF6600">public_key</font>,<font color="#FF6600">ssl</font>,<font color="#FF6600">gun</font>]}</tt></pre> +</div></div> <h2 id="_stopping">Stopping</h2> -<div class="sectionbody"> -<div class="paragraph"><p>You can stop Gun using the <code>application:stop/1</code> function, however -only Gun will be stopped. This is the reverse of <code>application:start/1</code>. -The <code>application_ensure_all_started/1</code> function has no equivalent for -stopping all applications.</p></div> -<div class="listingblock"> -<div class="title">Stopping Gun</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>You can stop Gun using the <code>application:stop/1</code> function, however only Gun will be stopped. This is the reverse of <code>application:start/1</code>. The <code>application_ensure_all_started/1</code> function has no equivalent for stopping all applications.</p> +<div class="listingblock"><div class="title">Stopping Gun</div> +<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">application:stop</span></span>(<span style="color: #FF6600">gun</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> +<pre><tt><b><font color="#000000">application:stop</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> + diff --git a/docs/en/gun/1.0/guide/websocket/index.html b/docs/en/gun/1.0/guide/websocket/index.html index a77f1319..67becc45 100644 --- a/docs/en/gun/1.0/guide/websocket/index.html +++ b/docs/en/gun/1.0/guide/websocket/index.html @@ -62,102 +62,88 @@ <h1 class="lined-header"><span>Websocket</span></h1> -<div class="paragraph"><p>This chapter describes how to use the Gun client for -communicating with a Websocket server.</p></div> -<div class="sect1"> +<p>This chapter describes how to use the Gun client for communicating with a Websocket server.</p> +<!-- @todo recovering from connection failure, reconnecting to Websocket etc.--> <h2 id="_http_upgrade">HTTP upgrade</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Websocket is a protocol built on top of HTTP. To use Websocket, -you must first request for the connection to be upgraded. Only -HTTP/1.1 connections can be upgraded to Websocket, so you might -need to restrict the protocol to HTTP/1.1 if you are planning -to use Websocket over TLS.</p></div> -<div class="paragraph"><p>You must use the <code>gun:ws_upgrade/2,3,4</code> function to upgrade -to Websocket. This function can be called anytime after connection, -so you can send HTTP requests before upgrading to Websocket.</p></div> -<div class="listingblock"> -<div class="title">Upgrade to Websocket</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Websocket is a protocol built on top of HTTP. To use Websocket, you must first request for the connection to be upgraded. Only HTTP/1.1 connections can be upgraded to Websocket, so you might need to restrict the protocol to HTTP/1.1 if you are planning to use Websocket over TLS.</p> +<p>You must use the <code>gun:ws_upgrade/2,3,4</code> function to upgrade to Websocket. This function can be called anytime after connection, so you can send HTTP requests before upgrading to Websocket.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket</div> +<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">gun:ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/websocket"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>Gun will set all the necessary headers for performing the -Websocket upgrade, but you can specify additional headers -if needed. For example you can request a custom sub-protocol.</p></div> -<div class="listingblock"> -<div class="title">Upgrade to Websocket and request a protocol</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<p>Gun will set all the necessary headers for performing the Websocket upgrade, but you can specify additional headers if needed. For example you can request a custom sub-protocol.</p> +<div class="listingblock"><div class="title">Upgrade to Websocket and request a protocol</div> +<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">gun:ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/websocket"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"sec-websocket-protocol"</span><span style="color: #990000">>></span>, <span style="color: #FF0000">"mychat"</span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>You can pass the Websocket options as part of the <code>gun:open/2,3</code> -call when opening the connection, or using the <code>gun:ws_upgrade/4</code>. -The fourth argument is those same options.</p></div> -<div class="paragraph"><p>When the upgrade succeeds, a <code>gun_upgrade</code> message is sent. -If the server does not understand Websocket or refused the -upgrade, a <code>gun_response</code> message is sent. If Gun couldn’t -perform the upgrade due to an error (for example attempting -to upgrade to Websocket on an HTTP/1.0 connection) then a -<code>gun_error</code> message is sent.</p></div> -<div class="paragraph"><p>When the server does not understand Websocket, it may send -a meaningful response which should be processed. In the -following example we however ignore it:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/websocket"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font>, <font color="#FF0000">"mychat"</font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<p>You can pass the Websocket options as part of the <code>gun:open/2,3</code> call when opening the connection, or using the <code>gun:ws_upgrade/4</code>. The fourth argument is those same options.</p> +<p>When the upgrade succeeds, a <code>gun_upgrade</code> message is sent. If the server does not understand Websocket or refused the upgrade, a <code>gun_response</code> message is sent. If Gun couldn't perform the upgrade due to an error (for example attempting to upgrade to Websocket on an HTTP/1.0 connection) then a <code>gun_error</code> message is sent.</p> +<p>When the server does not understand Websocket, it may send a meaningful response which should be processed. In the following example we however ignore it:</p> +<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: #0000FF">receive</span></span> - {<span style="color: #FF6600">gun_upgrade</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, [<span style="color: #990000"><<</span><span style="color: #FF0000">"websocket"</span><span style="color: #990000">>></span>], <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">upgrade_success</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>); - {<span style="color: #FF6600">gun_response</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #990000">_</span>, <span style="color: #990000">_</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>({<span style="color: #FF6600">ws_upgrade_failed</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>}); - {<span style="color: #FF6600">gun_error</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Reason</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>({<span style="color: #FF6600">ws_upgrade_failed</span>, <span style="color: #009900">Reason</span>}) - <span style="font-style: italic"><span style="color: #9A1900">%% More clauses here as needed.</span></span> -<span style="font-weight: bold"><span style="color: #0000FF">after</span></span> <span style="color: #993399">1000</span> <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000080">exit</span></span>(<span style="color: #FF6600">timeout</span>) -<span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>], <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000000">upgrade_success</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>); + {<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#990000">_</font>, <font color="#990000">_</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>({<font color="#FF6600">ws_upgrade_failed</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>}); + {<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Reason</font>} <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>({<font color="#FF6600">ws_upgrade_failed</font>, <font color="#009900">Reason</font>}) + <i><font color="#9A1900">%% More clauses here as needed.</font></i> +<b><font color="#0000FF">after</font></b> <font color="#993399">1000</font> <font color="#990000">-></font> + <b><font color="#000080">exit</font></b>(<font color="#FF6600">timeout</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_sending_data">Sending data</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Once the Websocket upgrade has completed successfully, you no -longer have access to functions for performing requests. You -can only send and receive Websocket messages.</p></div> -<div class="paragraph"><p>Use <code>gun:ws_send/2</code> to send messages to the server.</p></div> -<div class="listingblock"> -<div class="title">Send a text frame</div> -<div class="content"><!-- Generator: GNU source-highlight +<p>Once the Websocket upgrade has completed successfully, you no longer have access to functions for performing requests. You can only send and receive Websocket messages.</p> +<p>Use <code>gun:ws_send/2</code> to send messages to the server.</p> +<div class="listingblock"><div class="title">Send a text frame</div> +<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">gun:ws_send</span></span>(<span style="color: #009900">ConnPid</span>, {<span style="color: #FF6600">text</span>, <span style="color: #FF0000">"Hello!"</span>})<span style="color: #990000">.</span></tt></pre></div></div> -<div class="paragraph"><p>Note that if you send a close frame, Gun will close the connection -cleanly and will not attempt to reconnect afterwards.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, {<font color="#FF6600">text</font>, <font color="#FF0000">"Hello!"</font>})<font color="#990000">.</font></tt></pre> +</div></div> +<!-- @todo Implement sending of N frames--> +<!-- --> +<!-- .Send a text frame, a binary frame and then close the connection--> +<!-- [source,erlang]--> +<!-- ------> +<!-- gun:ws_send(ConnPid, [--> +<!-- {text, "Hello!"},--> +<!-- {binary, BinaryValue},--> +<!-- close--> +<!-- ]).--> +<!-- ------> +<p>Note that if you send a close frame, Gun will close the connection cleanly and will not attempt to reconnect afterwards.</p> <h2 id="_receiving_data">Receiving data</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun sends an Erlang message to the owner process for every -Websocket message it receives.</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>Gun sends an Erlang message to the owner process for every Websocket message it receives.</p> +<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: #0000FF">receive</span></span> - {<span style="color: #FF6600">gun_ws</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Frame</span>} <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">handle_frame</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Frame</span>) -<span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> +<pre><tt><b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>} <font color="#990000">-></font> + <b><font color="#000000">handle_frame</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<!-- @todo auto ping has not been implemented yet--> +<!-- --> +<!-- Gun will automatically send ping messages to the server to keep--> +<!-- the connection alive, however if the connection dies and Gun has--> +<!-- to reconnect it will not upgrade to Websocket automatically, you--> +<!-- need to perform the operation when you receive the `gun_error`--> +<!-- message.--> + diff --git a/docs/en/gun/1.0/manual/gun.await/index.html b/docs/en/gun/1.0/manual/gun.await/index.html index a0a9d77b..dd857dad 100644 --- a/docs/en/gun/1.0/manual/gun.await/index.html +++ b/docs/en/gun/1.0/manual/gun.await/index.html @@ -62,180 +62,94 @@ <h1 class="lined-header"><span>gun:await(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:await - Wait for a response</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:await - Wait for a response</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #993399">5000</span>, <span style="color: #009900">MonitorRef</span>) - -<span style="font-weight: bold"><span style="color: #000000">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">MonitorRef</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #993399">5000</span>, <span style="color: #009900">MonitorRef</span>) - -<span style="font-weight: bold"><span style="color: #000000">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Timeout</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Timeout</span>, <span style="color: #009900">MonitorRef</span>) - -<span style="font-weight: bold"><span style="color: #000000">await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Timeout</span>, <span style="color: #009900">MonitorRef</span>) - <span style="color: #990000">-></span> <span style="color: #009900">Result</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">MonitorRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></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: #009900">Result</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">tuple</span></span>() <span style="color: #990000">-</span> <span style="color: #FF6600">see</span> <span style="color: #FF6600">below</span></tt></pre></div></div> -<div class="paragraph"><p>Wait for a response.</p></div> -<div class="paragraph"><p>This function waits for a message from the given stream and -returns it as a tuple. An error will be returned should the -process fail or a relevant message is not received within -the specified duration.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <font color="#009900">Result</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Result</font> <font color="#990000">::</font> <b><font color="#000000">tuple</font></b>() <font color="#990000">-</font> <font color="#FF6600">see</font> <font color="#FF6600">below</font></tt></pre> +</div></div> +<p>Wait for a response.</p> +<p>This function waits for a message from the given stream and returns it as a tuple. An error will be returned should the process fail or a relevant message is not received within the specified duration.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -Timeout -</dt> -<dd> -<p> -How long to wait for a message, in milliseconds. -</p> +<dt>Timeout</dt> +<dd><p>How long to wait for a message, in milliseconds.</p> </dd> -<dt class="hdlist1"> -MonitorRef -</dt> -<dd> -<p> -Monitor for the Gun connection process. -</p> -<div class="paragraph"><p>A monitor is automatically created for the duration of this -call when one is not provided.</p></div> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A number of different tuples can be returned. They correspond -to the message of the same name and they contain the same -elements minus the pid and stream reference. Error tuples -may also be returned when a timeout or an error occur.</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>A number of different tuples can be returned. They correspond to the message of the same name and they contain the same elements minus the pid and stream reference. Error tuples may also be returned when a timeout or an error occur.</p> +<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="color: #009900">Result</span> <span style="color: #990000">::</span> {<span style="color: #FF6600">inform</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} - {<span style="color: #FF6600">response</span>, <span style="color: #009900">IsFin</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} - {<span style="color: #FF6600">data</span>, <span style="color: #009900">IsFin</span>, <span style="color: #009900">Data</span>} - {<span style="color: #FF6600">trailers</span>, <span style="color: #009900">Trailers</span>} - {<span style="color: #FF6600">push</span>, <span style="color: #009900">NewStreamRef</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">URI</span>, <span style="color: #009900">Headers</span>} - {<span style="color: #FF6600">error</span>, <span style="color: #009900">Reason</span>} - -<span style="color: #009900">Reason</span> <span style="color: #990000">::</span> <span style="color: #FF6600">timeout</span> | <span style="font-weight: bold"><span style="color: #000000">any</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Because the messages and returned tuples are equivalent, -please refer to the manual pages for each message for -further information:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun_push">gun_push(3)</a> - Server-initiated push -</p> +<pre><tt><font color="#009900">Result</font> <font color="#990000">::</font> {<font color="#FF6600">inform</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + {<font color="#FF6600">response</font>, <font color="#009900">IsFin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + {<font color="#FF6600">data</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>} + {<font color="#FF6600">trailers</font>, <font color="#009900">Trailers</font>} + {<font color="#FF6600">push</font>, <font color="#009900">NewStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">Reason</font> <font color="#990000">::</font> <font color="#FF6600">timeout</font> | <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Because the messages and returned tuples are equivalent, please refer to the manual pages for each message for further information:</p> +<ul><li><a href="../gun_push">gun_push(3)</a> - Server-initiated push </li> -<li> -<p> -<a href="../gun_inform">gun_inform(3)</a> - Informational response -</p> +<li><a href="../gun_inform">gun_inform(3)</a> - Informational response </li> -<li> -<p> -<a href="../gun_response">gun_response(3)</a> - Response -</p> +<li><a href="../gun_response">gun_response(3)</a> - Response </li> -<li> -<p> -<a href="../gun_data">gun_data(3)</a> - Response body -</p> +<li><a href="../gun_data">gun_data(3)</a> - Response body </li> -<li> -<p> -<a href="../gun_trailers">gun_trailers(3)</a> - Response trailers -</p> +<li><a href="../gun_trailers">gun_trailers(3)</a> - Response trailers </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Wait for a response</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Wait for a response</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/html;q=1.0, application/xml;q=0.1"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -{<span style="color: #FF6600">response</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #993399">200</span>, <span style="color: #009900">_Headers</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span> -{<span style="color: #FF6600">data</span>, <span style="color: #FF6600">fin</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"Hello world!"</span><span style="color: #990000">>></span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +{<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#993399">200</font>, <font color="#009900">_Headers</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font> +{<font color="#FF6600">data</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.options">gun:options(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.delete">gun:delete(3)</a>, -<a href="../gun.request">gun:request(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.await_body/index.html b/docs/en/gun/1.0/manual/gun.await_body/index.html index 56a94dbc..a3759bed 100644 --- a/docs/en/gun/1.0/manual/gun.await_body/index.html +++ b/docs/en/gun/1.0/manual/gun.await_body/index.html @@ -62,134 +62,70 @@ <h1 class="lined-header"><span>gun:await_body(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:await_body - Wait for the complete response body</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:await_body - Wait for the complete response body</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #993399">5000</span>, <span style="color: #009900">MonitorRef</span>) - -<span style="font-weight: bold"><span style="color: #000000">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">MonitorRef</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #993399">5000</span>, <span style="color: #009900">MonitorRef</span>) - -<span style="font-weight: bold"><span style="color: #000000">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Timeout</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Timeout</span>, <span style="color: #009900">MonitorRef</span>) - -<span style="font-weight: bold"><span style="color: #000000">await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Timeout</span>, <span style="color: #009900">MonitorRef</span>) - <span style="color: #990000">-></span> {<span style="color: #FF6600">ok</span>, <span style="color: #009900">Body</span>} | {<span style="color: #FF6600">ok</span>, <span style="color: #009900">Body</span>, <span style="color: #009900">Trailers</span>} | {<span style="color: #FF6600">error</span>, <span style="color: #009900">Reason</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">MonitorRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></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: #009900">Body</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">binary</span></span>() -<span style="color: #009900">Trailers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}] -<span style="color: #009900">Reason</span> <span style="color: #990000">::</span> <span style="color: #FF6600">timeout</span> | <span style="font-weight: bold"><span style="color: #000000">any</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Wait for the complete response body.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + +<b><font color="#000000">await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>} | {<font color="#FF6600">ok</font>, <font color="#009900">Body</font>, <font color="#009900">Trailers</font>} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Trailers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}] +<font color="#009900">Reason</font> <font color="#990000">::</font> <font color="#FF6600">timeout</font> | <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Wait for the complete response body.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -Timeout -</dt> -<dd> -<p> -How long to wait for each message, in milliseconds. -</p> +<dt>Timeout</dt> +<dd><p>How long to wait for each message, in milliseconds.</p> </dd> -<dt class="hdlist1"> -MonitorRef -</dt> -<dd> -<p> -Monitor for the Gun connection process. -</p> -<div class="paragraph"><p>A monitor is automatically created for the duration of this -call when one is not provided.</p></div> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The body is returned, possibly with trailers if the -request contained a <code>te: trailers</code> header. Error tuples -may also be returned when a timeout or an error occur.</p></div> -</div> -</div> -<div class="sect1"> +<p>The body is returned, possibly with trailers if the request contained a <code>te: trailers</code> header. Error tuples may also be returned when a timeout or an error occur.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Wait for the complete response body</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Wait for the complete response body</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/html;q=1.0, application/xml;q=0.1"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -{<span style="color: #FF6600">response</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #993399">200</span>, <span style="color: #009900">_Headers</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span> -{<span style="color: #FF6600">ok</span>, <span style="color: #009900">_Body</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await_body</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +{<font color="#FF6600">response</font>, <font color="#FF6600">nofin</font>, <font color="#993399">200</font>, <font color="#009900">_Headers</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>, <font color="#009900">_Body</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_body</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.options">gun:options(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.delete">gun:delete(3)</a>, -<a href="../gun.request">gun:request(3)</a>, -<a href="../gun.await">gun:await(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun.await">gun:await(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.await_up/index.html b/docs/en/gun/1.0/manual/gun.await_up/index.html index dc3eea5c..b437925e 100644 --- a/docs/en/gun/1.0/manual/gun.await_up/index.html +++ b/docs/en/gun/1.0/manual/gun.await_up/index.html @@ -62,115 +62,62 @@ <h1 class="lined-header"><span>gun:await_up(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:await_up - Wait for the connection to be up</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:await_up - Wait for the connection to be up</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">await_up</span></span>(<span style="color: #009900">ConnPid</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await_up</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #993399">5000</span>, <span style="color: #009900">MonitorRef</span>) +<pre><tt><b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) -<span style="font-weight: bold"><span style="color: #000000">await_up</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">MonitorRef</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await_up</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #993399">5000</span>, <span style="color: #009900">MonitorRef</span>) +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#993399">5000</font>, <font color="#009900">MonitorRef</font>) -<span style="font-weight: bold"><span style="color: #000000">await_up</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Timeout</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">await_up</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Timeout</span>, <span style="color: #009900">MonitorRef</span>) +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>) + <font color="#990000">-></font> <b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) -<span style="font-weight: bold"><span style="color: #000000">await_up</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Timeout</span>, <span style="color: #009900">MonitorRef</span>) - <span style="color: #990000">-></span> {<span style="color: #FF6600">ok</span>, <span style="color: #009900">Protocol</span>} | {<span style="color: #FF6600">error</span>, <span style="color: #009900">Reason</span>} +<b><font color="#000000">await_up</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Timeout</font>, <font color="#009900">MonitorRef</font>) + <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <font color="#009900">Protocol</font>} | {<font color="#FF6600">error</font>, <font color="#009900">Reason</font>} -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">MonitorRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></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: #009900">Protocol</span> <span style="color: #990000">::</span> <span style="color: #FF6600">http</span> | <span style="color: #FF6600">http2</span> -<span style="color: #009900">Reason</span> <span style="color: #990000">::</span> <span style="color: #FF6600">timeout</span> | <span style="font-weight: bold"><span style="color: #000000">any</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Wait for the connection to be up.</p></div> -</div> -</div> -<div class="sect1"> +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">MonitorRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Timeout</font> <font color="#990000">::</font> <b><font color="#000000">timeout</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> +<font color="#009900">Reason</font> <font color="#990000">::</font> <font color="#FF6600">timeout</font> | <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Wait for the connection to be up.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Timeout -</dt> -<dd> -<p> -How long to wait for, in milliseconds. -</p> +<dt>Timeout</dt> +<dd><p>How long to wait for, in milliseconds.</p> </dd> -<dt class="hdlist1"> -MonitorRef -</dt> -<dd> -<p> -Monitor for the Gun connection process. -</p> -<div class="paragraph"><p>A monitor is automatically created for the duration of this -call when one is not provided.</p></div> +<dt>MonitorRef</dt> +<dd><p>Monitor for the Gun connection process.</p> +<p>A monitor is automatically created for the duration of this call when one is not provided.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The protocol selected for this connection. It can be used -to determine the capabilities of the server. Error tuples -may also be returned when a timeout or an error occur.</p></div> -</div> -</div> -<div class="sect1"> +<p>The protocol selected for this connection. It can be used to determine the capabilities of the server. Error tuples may also be returned when a timeout or an error occur.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Wait for the connection to be up</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Wait for the connection to be up</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">443</span>)<span style="color: #990000">.</span> -{<span style="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:await_up</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font> +{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">gun:await_up</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a>, -<a href="../gun_up">gun_up(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.cancel/index.html b/docs/en/gun/1.0/manual/gun.cancel/index.html index ea356f54..76e8d19b 100644 --- a/docs/en/gun/1.0/manual/gun.cancel/index.html +++ b/docs/en/gun/1.0/manual/gun.cancel/index.html @@ -62,103 +62,48 @@ <h1 class="lined-header"><span>gun:cancel(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:cancel - Cancel the given stream</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:cancel - Cancel the given stream</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">cancel</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Cancel the given stream.</p></div> -<div class="paragraph"><p>The behavior of this function depends on the protocol -selected.</p></div> -<div class="paragraph"><p>HTTP/1.1 does not support this feature. Gun will simply -silence the stream and stop relaying messages. Gun may -also decide to close the connection if the response body -is too large, to avoid wasting time and bandwidth.</p></div> -<div class="paragraph"><p>HTTP/2 allows cancelling streams at any time.</p></div> -<div class="paragraph"><p>This function is asynchronous. Messages related to this -stream may still be sent after the function returns.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Cancel the given stream.</p> +<p>The behavior of this function depends on the protocol selected.</p> +<p>HTTP/1.1 does not support this feature. Gun will simply silence the stream and stop relaying messages. Gun may also decide to close the connection if the response body is too large, to avoid wasting time and bandwidth.</p> +<p>HTTP/2 allows cancelling streams at any time.</p> +<p>This function is asynchronous. Messages related to this stream may still be sent after the function returns.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is returned.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is returned.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Cancel a stream</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Cancel a stream</div> +<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">gun:cancel</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.options">gun:options(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.delete">gun:delete(3)</a>, -<a href="../gun.request">gun:request(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.request">gun:request(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.close/index.html b/docs/en/gun/1.0/manual/gun.close/index.html index ab536f8d..6c0b82e1 100644 --- a/docs/en/gun/1.0/manual/gun.close/index.html +++ b/docs/en/gun/1.0/manual/gun.close/index.html @@ -62,79 +62,40 @@ <h1 class="lined-header"><span>gun:close(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:close - Brutally close the connection</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:close - Brutally close the connection</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">close</span></span>(<span style="color: #009900">ConnPid</span>) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> +<pre><tt><b><font color="#000000">close</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Brutally close the connection.</p></div> -</div> -</div> -<div class="sect1"> +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>()</tt></pre> +</div></div> +<p>Brutally close the connection.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is returned.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is returned.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Close the connection</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Close the connection</div> +<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="color: #0000FF">ok</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:close</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#0000FF">ok</font> <font color="#990000">=</font> <b><font color="#000000">gun:close</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.data/index.html b/docs/en/gun/1.0/manual/gun.data/index.html index 8382616e..97b689bd 100644 --- a/docs/en/gun/1.0/manual/gun.data/index.html +++ b/docs/en/gun/1.0/manual/gun.data/index.html @@ -62,119 +62,59 @@ <h1 class="lined-header"><span>gun:data(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:data - Stream the body of a request</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:data - Stream the body of a request</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">IsFin</span>, <span style="color: #009900">Data</span>) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">IsFin</span> <span style="color: #990000">::</span> <span style="color: #FF6600">fin</span> | <span style="color: #FF6600">nofin</span> -<span style="color: #009900">Data</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Stream the body of a request.</p></div> -<div class="paragraph"><p>This function can only be used if the original request -had headers indicating that a body would be streamed.</p></div> -<div class="paragraph"><p>All calls to this function must use the <code>nofin</code> flag -except for the last which must use <code>fin</code> to indicate -the end of the request body.</p></div> -<div class="paragraph"><p>Empty data is allowed regardless of the value of <code>IsFin</code>. -Gun may or may not send empty data chunks, however.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()</tt></pre> +</div></div> +<p>Stream the body of a request.</p> +<p>This function can only be used if the original request had headers indicating that a body would be streamed.</p> +<p>All calls to this function must use the <code>nofin</code> flag except for the last which must use <code>fin</code> to indicate the end of the request body.</p> +<p>Empty data is allowed regardless of the value of <code>IsFin</code>. Gun may or may not send empty data chunks, however.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -IsFin -</dt> -<dd> -<p> -Whether this message terminates the request. -</p> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the request.</p> </dd> -<dt class="hdlist1"> -Data -</dt> -<dd> -<p> -All or part of the response body. -</p> +<dt>Data</dt> +<dd><p>All or part of the response body.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is returned.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is returned.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Stream the body of a request</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Stream the body of a request</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/lang/fr_FR/hello"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/plain"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">nofin</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"Bonjour !\n"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"Bonsoir !\n"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">nofin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonjour !\n"</font><font color="#990000">>></font>)<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonsoir !\n"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.request">gun:request(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.request">gun:request(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.delete/index.html b/docs/en/gun/1.0/manual/gun.delete/index.html index 62c25d81..d13544b4 100644 --- a/docs/en/gun/1.0/manual/gun.delete/index.html +++ b/docs/en/gun/1.0/manual/gun.delete/index.html @@ -62,130 +62,68 @@ <h1 class="lined-header"><span>gun:delete(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:delete - Delete a resource</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:delete - Delete a resource</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, [], #{})<span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000000">delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Delete a resource.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Delete a resource.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Delete a resource</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Delete a resource</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/drafts/123"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Delete a resource with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/drafts/123"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Delete a resource with request options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:delete</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/drafts/123"</span>, [], - #{<span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:delete</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/drafts/123"</font>, [], + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.flush/index.html b/docs/en/gun/1.0/manual/gun.flush/index.html index 13263727..43420e8d 100644 --- a/docs/en/gun/1.0/manual/gun.flush/index.html +++ b/docs/en/gun/1.0/manual/gun.flush/index.html @@ -62,98 +62,53 @@ <h1 class="lined-header"><span>gun:flush(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:flush - Flush all messages related to a connection or a stream</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:flush - Flush all messages related to a connection or a stream</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">flush</span></span>(<span style="color: #009900">ConnPid</span>) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> -<span style="font-weight: bold"><span style="color: #000000">flush</span></span>(<span style="color: #009900">StreamRef</span>) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> +<pre><tt><b><font color="#000000">flush</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> +<b><font color="#000000">flush</font></b>(<font color="#009900">StreamRef</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Flush all messages related to a connection or a stream.</p></div> -</div> -</div> -<div class="sect1"> +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Flush all messages related to a connection or a stream.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Either of these arguments may be provided:</p></div> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<p>Either of these arguments may be provided:</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is returned.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is returned.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Flush all messages from a connection</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Flush all messages from a connection</div> +<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">gun:flush</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Flush messages from a single stream</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Flush messages from a single stream</div> +<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">gun:flush</span></span>(<span style="color: #009900">StreamRef</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:flush</font></b>(<font color="#009900">StreamRef</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun.await_up">gun:await_up(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.get/index.html b/docs/en/gun/1.0/manual/gun.get/index.html index a1864b6c..5945cfc9 100644 --- a/docs/en/gun/1.0/manual/gun.get/index.html +++ b/docs/en/gun/1.0/manual/gun.get/index.html @@ -62,133 +62,71 @@ <h1 class="lined-header"><span>gun:get(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:get - Get a resource representation</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:get - Get a resource representation</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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: #000080">get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000080">get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, [], #{})<span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000080">get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000080">get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000080">get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Get a resource representation.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000080">get</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Get a resource representation.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Get a resource representation</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Get a resource representation</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/html;q=1.0, application/xml;q=0.1"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Get a resource representation with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get a resource representation with request options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:get</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [], #{ - <span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span> -})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:get</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.head/index.html b/docs/en/gun/1.0/manual/gun.head/index.html index 8afd0163..1341d833 100644 --- a/docs/en/gun/1.0/manual/gun.head/index.html +++ b/docs/en/gun/1.0/manual/gun.head/index.html @@ -62,138 +62,73 @@ <h1 class="lined-header"><span>gun:head(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:head - Get headers of a resource representation</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:head - Get headers of a resource representation</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, [], #{})<span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Get headers of a resource representation.</p></div> -<div class="paragraph"><p>This function performs the same operation as -<a href="../gun.get">gun:get(3)</a>, except the server will not -send the resource representation, only the response’s status -code and headers.</p></div> -<div class="paragraph"><p>While servers are supposed to send the same headers as for -a GET request, they sometimes will not. For example the -<code>content-length</code> header may be dropped from the response.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Get headers of a resource representation.</p> +<p>This function performs the same operation as <a href="../gun.get">gun:get(3)</a>, except the server will not send the resource representation, only the response's status code and headers.</p> +<p>While servers are supposed to send the same headers as for a GET request, they sometimes will not. For example the <code>content-length</code> header may be dropped from the response.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Get headers of a resource representation</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Get headers of a resource representation</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/html;q=1.0, application/xml;q=0.1"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Get headers of a resource representation with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get headers of a resource representation with request options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [], #{ - <span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span> -})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:head(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.info/index.html b/docs/en/gun/1.0/manual/gun.info/index.html index 7b94f600..2206a94e 100644 --- a/docs/en/gun/1.0/manual/gun.info/index.html +++ b/docs/en/gun/1.0/manual/gun.info/index.html @@ -62,84 +62,44 @@ <h1 class="lined-header"><span>gun:info(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:info - Obtain information about the connection</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:info - Obtain information about the connection</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">info</span></span>(<span style="color: #009900">ConnPid</span>) <span style="color: #990000">-></span> <span style="color: #009900">Info</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Info</span> <span style="color: #990000">::</span> #{ - <span style="color: #0000FF">sock_ip</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">inet:ip_address</span></span>(), - <span style="color: #0000FF">sock_port</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">inet:port_number</span></span>() -}</tt></pre></div></div> -<div class="paragraph"><p>Obtain information about the connection.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">info</font></b>(<font color="#009900">ConnPid</font>) <font color="#990000">-></font> <font color="#009900">Info</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Info</font> <font color="#990000">::</font> #{ + <font color="#0000FF">sock_ip</font> <font color="#990000">=></font> <b><font color="#000000">inet:ip_address</font></b>(), + <font color="#0000FF">sock_port</font> <font color="#990000">=></font> <b><font color="#000000">inet:port_number</font></b>() +}</tt></pre> +</div></div> +<p>Obtain information about the connection.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A map is returned containing various informations about -the connection.</p></div> -</div> -</div> -<div class="sect1"> +<p>A map is returned containing various informations about the connection.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Obtain information about the connection</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Obtain information about the connection</div> +<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="color: #009900">Info</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:info</span></span>(<span style="color: #009900">ConnPid</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">Info</font> <font color="#990000">=</font> <b><font color="#000000">gun:info</font></b>(<font color="#009900">ConnPid</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.open/index.html b/docs/en/gun/1.0/manual/gun.open/index.html index 2f1548fe..86cb145b 100644 --- a/docs/en/gun/1.0/manual/gun.open/index.html +++ b/docs/en/gun/1.0/manual/gun.open/index.html @@ -62,117 +62,64 @@ <h1 class="lined-header"><span>gun:open(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:open - Open a connection to the given host and port</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:open - Open a connection to the given host and port</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">open</span></span>(<span style="color: #009900">Host</span>, <span style="color: #009900">Port</span>) <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">open</span></span>(<span style="color: #009900">Host</span>, <span style="color: #009900">Port</span>, #{}) -<span style="font-weight: bold"><span style="color: #000000">open</span></span>(<span style="color: #009900">Host</span>, <span style="color: #009900">Port</span>, <span style="color: #009900">Opts</span>) <span style="color: #990000">-></span> {<span style="color: #FF6600">ok</span>, <span style="font-weight: bold"><span style="color: #000080">pid</span></span>()} | {<span style="color: #FF6600">error</span>, <span style="font-weight: bold"><span style="color: #000000">any</span></span>()} - -<span style="color: #009900">Host</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">inet:hostname</span></span>() | <span style="font-weight: bold"><span style="color: #000000">inet:ip_address</span></span>() -<span style="color: #009900">Port</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">inet:port_number</span></span>() -<span style="color: #009900">Opts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:opts</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Open a connection to the given host and port.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>) <font color="#990000">-></font> <b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, #{}) +<b><font color="#000000">open</font></b>(<font color="#009900">Host</font>, <font color="#009900">Port</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000080">pid</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()} + +<font color="#009900">Host</font> <font color="#990000">::</font> <b><font color="#000000">inet:hostname</font></b>() | <b><font color="#000000">inet:ip_address</font></b>() +<font color="#009900">Port</font> <font color="#990000">::</font> <b><font color="#000000">inet:port_number</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:opts</font></b>()</tt></pre> +</div></div> +<p>Open a connection to the given host and port.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -Host -</dt> -<dd> -<p> -Host or IP address to connect to. -</p> +<dl><dt>Host</dt> +<dd><p>Host or IP address to connect to.</p> </dd> -<dt class="hdlist1"> -Port -</dt> -<dd> -<p> -Port to connect to. -</p> +<dt>Port</dt> +<dd><p>Port to connect to.</p> </dd> -<dt class="hdlist1"> -Opts -</dt> -<dd> -<p> -Options for this connection. -</p> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The pid of the newly created Gun process is returned. -Note that this does not indicate that the connection -has been successfully opened; the <a href="../gun_up">gun_up(3)</a> -message will be sent for that.</p></div> -</div> -</div> -<div class="sect1"> +<p>The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the <a href="../gun_up">gun_up(3)</a> message will be sent for that.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Connect to a server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Connect to a server</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">443</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Connect to a server with custom options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server with custom options</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>(<span style="color: #FF0000">"example.org"</span>, <span style="color: #993399">443</span>, - #{<span style="color: #0000FF">protocols</span> <span style="color: #990000">=></span> [<span style="color: #FF6600">http2</span>]})<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Connect to a server using its IP address</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>(<font color="#FF0000">"example.org"</font>, <font color="#993399">443</font>, + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>]})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server using its IP address</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open</span></span>({<span style="color: #993399">127</span>,<span style="color: #993399">0</span>,<span style="color: #993399">0</span>,<span style="color: #993399">1</span>}, <span style="color: #993399">443</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open</font></b>({<font color="#993399">127</font>,<font color="#993399">0</font>,<font color="#993399">0</font>,<font color="#993399">1</font>}, <font color="#993399">443</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a>, -<a href="../gun.await_up">gun:await_up(3)</a>, -<a href="../gun_up">gun_up(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.open_unix/index.html b/docs/en/gun/1.0/manual/gun.open_unix/index.html index 96253f64..60b9c630 100644 --- a/docs/en/gun/1.0/manual/gun.open_unix/index.html +++ b/docs/en/gun/1.0/manual/gun.open_unix/index.html @@ -62,100 +62,52 @@ <h1 class="lined-header"><span>gun:open_unix(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:open_unix - Open a connection to the given Unix domain socket</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:open_unix - Open a connection to the given Unix domain socket</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">open_unix</span></span>(<span style="color: #009900">SocketPath</span>, <span style="color: #009900">Opts</span>) <span style="color: #990000">-></span> {<span style="color: #FF6600">ok</span>, <span style="font-weight: bold"><span style="color: #000080">pid</span></span>()} | {<span style="color: #FF6600">error</span>, <span style="font-weight: bold"><span style="color: #000000">any</span></span>()} +<pre><tt><b><font color="#000000">open_unix</font></b>(<font color="#009900">SocketPath</font>, <font color="#009900">Opts</font>) <font color="#990000">-></font> {<font color="#FF6600">ok</font>, <b><font color="#000080">pid</font></b>()} | {<font color="#FF6600">error</font>, <b><font color="#000000">any</font></b>()} -<span style="color: #009900">SocketPath</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">string</span></span>() -<span style="color: #009900">Opts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:opts</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Open a connection to the given Unix domain socket.</p></div> -</div> -</div> -<div class="sect1"> +<font color="#009900">SocketPath</font> <font color="#990000">::</font> <b><font color="#000000">string</font></b>() +<font color="#009900">Opts</font> <font color="#990000">::</font> <b><font color="#000000">gun:opts</font></b>()</tt></pre> +</div></div> +<p>Open a connection to the given Unix domain socket.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -SocketPath -</dt> -<dd> -<p> -Path to the Unix domain socket to connect to. -</p> +<dl><dt>SocketPath</dt> +<dd><p>Path to the Unix domain socket to connect to.</p> </dd> -<dt class="hdlist1"> -Opts -</dt> -<dd> -<p> -Options for this connection. -</p> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The pid of the newly created Gun process is returned. -Note that this does not indicate that the connection -has been successfully opened; the <a href="../gun_up">gun_up(3)</a> -message will be sent for that.</p></div> -</div> -</div> -<div class="sect1"> +<p>The pid of the newly created Gun process is returned. Note that this does not indicate that the connection has been successfully opened; the <a href="../gun_up">gun_up(3)</a> message will be sent for that.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Connect to a server via a Unix domain socket</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Connect to a server via a Unix domain socket</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open_unix</span></span>(<span style="color: #FF0000">"/var/run/dbus/system_bus_socket"</span>, #{})<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Connect to a server via a Unix domain socket with custom options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open_unix</font></b>(<font color="#FF0000">"/var/run/dbus/system_bus_socket"</font>, #{})<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Connect to a server via a Unix domain socket with custom options</div> +<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="color: #FF6600">ok</span>, <span style="color: #009900">ConnPid</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:open_unix</span></span>(<span style="color: #FF0000">"/var/run/dbus/system_bus_socket"</span>, - #{<span style="color: #0000FF">protocols</span> <span style="color: #990000">=></span> [<span style="color: #FF6600">http2</span>]})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#009900">ConnPid</font>} <font color="#990000">=</font> <b><font color="#000000">gun:open_unix</font></b>(<font color="#FF0000">"/var/run/dbus/system_bus_socket"</font>, + #{<font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http2</font>]})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.await_up">gun:await_up(3)</a>, -<a href="../gun_up">gun_up(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_up">gun_up(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.options/index.html b/docs/en/gun/1.0/manual/gun.options/index.html index 4a3c50aa..e2bcb8be 100644 --- a/docs/en/gun/1.0/manual/gun.options/index.html +++ b/docs/en/gun/1.0/manual/gun.options/index.html @@ -62,130 +62,68 @@ <h1 class="lined-header"><span>gun:options(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:options - Query the capabilities of the server or a resource</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:options - Query the capabilities of the server or a resource</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, [], #{})<span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000000">options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Query the capabilities of the server or a resource.</p></div> -<div class="paragraph"><p>The special path <code>"*"</code> can be used to obtain information about -the server as a whole. Any other path will return information -about that resource specifically.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">options</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Query the capabilities of the server or a resource.</p> +<p>The special path <code>"*"</code> can be used to obtain information about the server as a whole. Any other path will return information about that resource specifically.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Query the capabilities of the server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Query the capabilities of the server</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"*"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Query the capabilities of a resource</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"*"</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Query the capabilities of a resource</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:options</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:options</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.patch/index.html b/docs/en/gun/1.0/manual/gun.patch/index.html index 54ab78b4..00befe21 100644 --- a/docs/en/gun/1.0/manual/gun.patch/index.html +++ b/docs/en/gun/1.0/manual/gun.patch/index.html @@ -62,168 +62,91 @@ <h1 class="lined-header"><span>gun:patch(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:patch - Apply a set of changes to a resource</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:patch - Apply a set of changes to a resource</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="font-weight: bold"><span style="color: #000000">patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">Body</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Apply a set of changes to a resource.</p></div> -<div class="paragraph"><p>The behavior of this function varies depending on whether -a body is provided.</p></div> -<div class="paragraph"><p>The function <code>patch/3</code> expects either a content-length -or content-type header to indicate that a body will be -sent afterwards. The body can then be sent using -<a href="../gun.data">gun:data(3)</a>.</p></div> -<div class="paragraph"><p>The function <code>patch/4,5</code> sends the entire request, including -the request body, immediately. It is therefore not possible -to use <a href="../gun.data">gun:data(3)</a> after that. You -should provide a content-type header. Gun will set the -content-length header automatically.</p></div> -<div class="paragraph"><p>The body sent in this request should be a patch document -with instructions on how to update the resource.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Apply a set of changes to a resource.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>patch/3</code> expects either a content-length or content-type header to indicate that a body will be sent afterwards. The body can then be sent using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>patch/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> +<p>The body sent in this request should be a patch document with instructions on how to update the resource.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -Body -</dt> -<dd> -<p> -Request body. -</p> +<dt>Body</dt> +<dd><p>Request body.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Patch a resource</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Patch a resource</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/users/1"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"application/json-patch+json"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Patch a resource in multiple calls</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Patch a resource in multiple calls</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/users/1"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"application/json-patch+json"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, - <span style="color: #990000"><<</span><span style="color: #FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Patch a resource with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Patch a resource with request options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:patch</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/users/1"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"application/json-patch+json"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</span><span style="color: #990000">>></span>, - #{<span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:patch</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/users/1"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/json-patch+json"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"[{\"op\":\"add\",\"path\":\"/baz\",\"value\":\"qux\"}]"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.post/index.html b/docs/en/gun/1.0/manual/gun.post/index.html index 9f6ee6e2..782e8346 100644 --- a/docs/en/gun/1.0/manual/gun.post/index.html +++ b/docs/en/gun/1.0/manual/gun.post/index.html @@ -62,166 +62,89 @@ <h1 class="lined-header"><span>gun:post(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:post - Process the enclosed representation according to a resource’s own semantics</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:post - Process the enclosed representation according to a resource's own semantics</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="font-weight: bold"><span style="color: #000000">post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">Body</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Process the enclosed representation according to a resource’s -own semantics.</p></div> -<div class="paragraph"><p>The behavior of this function varies depending on whether -a body is provided.</p></div> -<div class="paragraph"><p>The function <code>post/3</code> expects either a content-length -or content-type header to indicate that a body will be -sent afterwards. The body can then be sent using -<a href="../gun.data">gun:data(3)</a>.</p></div> -<div class="paragraph"><p>The function <code>post/4,5</code> sends the entire request, including -the request body, immediately. It is therefore not possible -to use <a href="../gun.data">gun:data(3)</a> after that. You -should provide a content-type header. Gun will set the -content-length header automatically.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">post</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Process the enclosed representation according to a resource's own semantics.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>post/3</code> expects either a content-length or content-type header to indicate that a body will be sent afterwards. The body can then be sent using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>post/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -Body -</dt> -<dd> -<p> -Request body. -</p> +<dt>Body</dt> +<dd><p>Request body.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Post to a resource</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Post to a resource</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/search"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"application/x-www-form-urlencoded"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"q=nine%20nines"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Post to a resource in multiple calls</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Post to a resource in multiple calls</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/search"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"application/x-www-form-urlencoded"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"q=nine%20nines"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Post to a resource with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Post to a resource with request options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:post</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/search"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"application/x-www-form-urlencoded"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"q=nine%20nines"</span><span style="color: #990000">>></span>, - #{<span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:post</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/search"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"application/x-www-form-urlencoded"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"q=nine%20nines"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.put/index.html b/docs/en/gun/1.0/manual/gun.put/index.html index ae72aded..71f3f345 100644 --- a/docs/en/gun/1.0/manual/gun.put/index.html +++ b/docs/en/gun/1.0/manual/gun.put/index.html @@ -62,165 +62,89 @@ <h1 class="lined-header"><span>gun:put(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:put - Create or replace a resource</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:put - Create or replace a resource</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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: #000080">put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="font-weight: bold"><span style="color: #000080">put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000080">put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000080">put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">Body</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Create or replace a resource.</p></div> -<div class="paragraph"><p>The behavior of this function varies depending on whether -a body is provided.</p></div> -<div class="paragraph"><p>The function <code>put/3</code> expects either a content-length -or content-type header to indicate that a body will be -sent afterwards. The body can then be sent using -<a href="../gun.data">gun:data(3)</a>.</p></div> -<div class="paragraph"><p>The function <code>put/4,5</code> sends the entire request, including -the request body, immediately. It is therefore not possible -to use <a href="../gun.data">gun:data(3)</a> after that. You -should provide a content-type header. Gun will set the -content-length header automatically.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000080">put</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Create or replace a resource.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>put/3</code> expects either a content-length or content-type header to indicate that a body will be sent afterwards. The body can then be sent using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>put/4,5</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -Body -</dt> -<dd> -<p> -Request body. -</p> +<dt>Body</dt> +<dd><p>Request body.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Put a resource</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Put a resource</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/lang/fr_FR/hello"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/plain"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"Bonjour !"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Put a resource in multiple calls</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Put a resource in multiple calls</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/lang/fr_FR/hello"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/plain"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #000000">gun:data</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #FF6600">fin</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"Bonjour !"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Put a resource with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#000000">gun:data</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#FF6600">fin</font>, <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Put a resource with request options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:put</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/lang/fr_FR/hello"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/plain"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"Bonjour !"</span><span style="color: #990000">>></span>, - #{<span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:put</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>, + #{<font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font>})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.request/index.html b/docs/en/gun/1.0/manual/gun.request/index.html index e5dad30d..6567c699 100644 --- a/docs/en/gun/1.0/manual/gun.request/index.html +++ b/docs/en/gun/1.0/manual/gun.request/index.html @@ -62,156 +62,75 @@ <h1 class="lined-header"><span>gun:request(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:request - Perform the given request</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:request - Perform the given request</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">request</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="font-weight: bold"><span style="color: #000000">request</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">request</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">request</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">Body</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Method</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">binary</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">Body</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Perform the given request.</p></div> -<div class="paragraph"><p>This is a general purpose function that should only be -used when other method-specific functions do not apply.</p></div> -<div class="paragraph"><p>The behavior of this function varies depending on whether -a body is provided.</p></div> -<div class="paragraph"><p>The function <code>request/4</code> expects either a content-length -or content-type header to indicate that a body will be -sent afterwards. Gun will assume the request has no body -otherwise. The body can then be sent using -<a href="../gun.data">gun:data(3)</a>.</p></div> -<div class="paragraph"><p>The function <code>request/5,6</code> sends the entire request, including -the request body, immediately. It is therefore not possible -to use <a href="../gun.data">gun:data(3)</a> after that. You -should provide a content-type header. Gun will set the -content-length header automatically.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>) + <font color="#990000">-></font> <b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, #{}) + +<b><font color="#000000">request</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Method</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">Body</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">Body</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Perform the given request.</p> +<p>This is a general purpose function that should only be used when other method-specific functions do not apply.</p> +<p>The behavior of this function varies depending on whether a body is provided.</p> +<p>The function <code>request/4</code> expects either a content-length or content-type header to indicate that a body will be sent afterwards. Gun will assume the request has no body otherwise. The body can then be sent using <a href="../gun.data">gun:data(3)</a>.</p> +<p>The function <code>request/5,6</code> sends the entire request, including the request body, immediately. It is therefore not possible to use <a href="../gun.data">gun:data(3)</a> after that. You should provide a content-type header. Gun will set the content-length header automatically.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Method -</dt> -<dd> -<p> -Method to be used for the request. -</p> +<dt>Method</dt> +<dd><p>Method to be used for the request.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -Body -</dt> -<dd> -<p> -Request body. -</p> +<dt>Body</dt> +<dd><p>Request body.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Perform a request</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Perform a request</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:request</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"PUT"</span><span style="color: #990000">>></span>, - <span style="color: #FF0000">"/lang/fr_FR/hello"</span>, - [{<span style="color: #990000"><<</span><span style="color: #FF0000">"content-type"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/plain"</span><span style="color: #990000">>></span>}], - <span style="color: #990000"><<</span><span style="color: #FF0000">"Bonjour !"</span><span style="color: #990000">>></span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:request</font></b>(<font color="#009900">ConnPid</font>, <font color="#990000"><<</font><font color="#FF0000">"PUT"</font><font color="#990000">>></font>, + <font color="#FF0000">"/lang/fr_FR/hello"</font>, + [{<font color="#990000"><<</font><font color="#FF0000">"content-type"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/plain"</font><font color="#990000">>></font>}], + <font color="#990000"><<</font><font color="#FF0000">"Bonjour !"</font><font color="#990000">>></font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun.await_body">gun:await_body(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun.await_body">gun:await_body(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.ws_send/index.html b/docs/en/gun/1.0/manual/gun.ws_send/index.html index 8892da18..a0b34903 100644 --- a/docs/en/gun/1.0/manual/gun.ws_send/index.html +++ b/docs/en/gun/1.0/manual/gun.ws_send/index.html @@ -62,94 +62,57 @@ <h1 class="lined-header"><span>gun:ws_send(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:ws_send - Send Websocket frames</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:ws_send - Send Websocket frames</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">ws_send</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Frames</span>) <span style="color: #990000">-></span> <span style="color: #FF6600">ok</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Frames</span> <span style="color: #990000">::</span> <span style="color: #009900">Frame</span> | [<span style="color: #009900">Frame</span>] -<span style="color: #009900">Frame</span> <span style="color: #990000">::</span> <span style="color: #FF6600">close</span> | <span style="color: #FF6600">ping</span> | <span style="color: #FF6600">pong</span> - | {<span style="color: #FF6600">text</span> | <span style="font-weight: bold"><span style="color: #000080">binary</span></span> | <span style="color: #FF6600">close</span> | <span style="color: #FF6600">ping</span> | <span style="color: #FF6600">pong</span>, <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()} - | {<span style="color: #FF6600">close</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}</tt></pre></div></div> -<div class="paragraph"><p>Send Websocket frames.</p></div> -<div class="paragraph"><p>The connection must first be upgraded to Websocket using -the function <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">ws_send</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Frames</font>) <font color="#990000">-></font> <font color="#FF6600">ok</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Frames</font> <font color="#990000">::</font> <font color="#009900">Frame</font> | [<font color="#009900">Frame</font>] +<font color="#009900">Frame</font> <font color="#990000">::</font> <font color="#FF6600">close</font> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font> + | {<font color="#FF6600">text</font> | <b><font color="#000080">binary</font></b> | <font color="#FF6600">close</font> | <font color="#FF6600">ping</font> | <font color="#FF6600">pong</font>, <b><font color="#000000">iodata</font></b>()} + | {<font color="#FF6600">close</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000000">iodata</font></b>()}</tt></pre> +</div></div> +<p>Send Websocket frames.</p> +<p>The connection must first be upgraded to Websocket using the function <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Frames -</dt> -<dd> -<p> -A Websocket frame. -</p> +<dt>Frames</dt> +<dd><p>A Websocket frame.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> +<!-- @todo One or more Websocket frame(s).--> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The atom <code>ok</code> is returned.</p></div> -</div> -</div> -<div class="sect1"> +<p>The atom <code>ok</code> is returned.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Send a single frame</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Send a single frame</div> +<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">gun:ws_send</span></span>(<span style="color: #009900">ConnPid</span>, {<span style="color: #FF6600">text</span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"Hello world!"</span><span style="color: #990000">>></span>})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">gun:ws_send</font></b>(<font color="#009900">ConnPid</font>, {<font color="#FF6600">text</font>, <font color="#990000"><<</font><font color="#FF0000">"Hello world!"</font><font color="#990000">>></font>})<font color="#990000">.</font></tt></pre> +</div></div> +<!-- .Send many frames including a close frame--> +<!-- [source,erlang]--> +<!-- ------> +<!-- gun:ws_send(ConnPid, [--> +<!-- {text, <<"See you later, world!">>},--> +<!-- close--> +<!-- ]).--> +<!-- ------> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, -<a href="../gun_upgrade">gun_upgrade(3)</a>, -<a href="../gun_ws">gun_ws(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html b/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html index d74702db..998ffe89 100644 --- a/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun.ws_upgrade/index.html @@ -62,144 +62,81 @@ <h1 class="lined-header"><span>gun:ws_upgrade(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:ws_upgrade - Upgrade to Websocket</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:ws_upgrade - Upgrade to Websocket</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, []) - -<span style="font-weight: bold"><span style="color: #000000">ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="font-weight: bold"><span style="color: #000000">ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">WsOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">WsOpts</span> <span style="color: #990000">::</span> <span style="color: #FF6600">gun</span><span style="color: #990000">:</span><span style="color: #FF6600">ws_opts</span> -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Upgrade to Websocket.</p></div> -<div class="paragraph"><p>The behavior of this function depends on the protocol -selected.</p></div> -<div class="paragraph"><p>HTTP/1.1 cannot handle Websocket and HTTP requests -concurrently. The upgrade, if successful, will result -in the complete takeover of the connection. Any -subsequent HTTP requests will be rejected.</p></div> -<div class="paragraph"><p>Gun does not currently support Websocket over HTTP/2.</p></div> -<div class="paragraph"><p>By default Gun will take the Websocket options from -the connection’s <code>ws_opts</code>.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, []) + +<b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<b><font color="#000000">ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">WsOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">WsOpts</font> <font color="#990000">::</font> <font color="#FF6600">gun</font><font color="#990000">:</font><font color="#FF6600">ws_opts</font> +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Upgrade to Websocket.</p> +<p>The behavior of this function depends on the protocol selected.</p> +<p>HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if successful, will result in the complete takeover of the connection. Any subsequent HTTP requests will be rejected.</p> +<p>Gun does not currently support Websocket over HTTP/2.</p> +<p>By default Gun will take the Websocket options from the connection's <code>ws_opts</code>.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -WsOpts -</dt> -<dd> -<p> -Configuration for the Websocket protocol. -</p> +<dt>WsOpts</dt> +<dd><p>Configuration for the Websocket protocol.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Upgrade to Websocket</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Upgrade to Websocket</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/ws"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"sec-websocket-protocol"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"chat"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #0000FF">receive</span></span> - {<span style="color: #FF6600">gun_upgrade</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, [<span style="color: #990000"><<</span><span style="color: #FF0000">"websocket"</span><span style="color: #990000">>></span>], <span style="color: #990000">_</span>} <span style="color: #990000">-></span> - <span style="color: #FF6600">ok</span> -<span style="font-weight: bold"><span style="color: #0000FF">after</span></span> <span style="color: #993399">5000</span> <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">error</span></span>(<span style="color: #FF6600">timeout</span>) -<span style="font-weight: bold"><span style="color: #0000FF">end</span></span><span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Upgrade to Websocket with different options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"sec-websocket-protocol"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"chat"</font><font color="#990000">>></font>} +])<font color="#990000">.</font> +<b><font color="#0000FF">receive</font></b> + {<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>], <font color="#990000">_</font>} <font color="#990000">-></font> + <font color="#FF6600">ok</font> +<b><font color="#0000FF">after</font></b> <font color="#993399">5000</font> <font color="#990000">-></font> + <b><font color="#000000">error</font></b>(<font color="#FF6600">timeout</font>) +<b><font color="#0000FF">end</font></b><font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Upgrade to Websocket with different options</div> +<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="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:ws_upgrade</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/ws"</span>, [], #{ - <span style="color: #0000FF">compress</span> <span style="color: #990000">=></span> <span style="color: #000080">false</span> -})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:ws_upgrade</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/ws"</font>, [], #{ + <font color="#0000FF">compress</font> <font color="#990000">=></font> <font color="#000080">false</font> +})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.ws_send">gun:ws_send(3)</a>, -<a href="../gun_upgrade">gun_upgrade(3)</a>, -<a href="../gun_ws">gun_ws(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun/index.html b/docs/en/gun/1.0/manual/gun/index.html index e08aca7f..a9d5905e 100644 --- a/docs/en/gun/1.0/manual/gun/index.html +++ b/docs/en/gun/1.0/manual/gun/index.html @@ -62,454 +62,219 @@ <h1 class="lined-header"><span>gun(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun - Asynchronous HTTP client</p></div> -</div> -</div> -<div class="sect1"> +<p>gun - Asynchronous HTTP client</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>gun</code> module provides an asynchronous interface for -connecting and communicating with Web servers over HTTP, -HTTP/2 or Websocket.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <code>gun</code> module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket.</p> <h2 id="_exports">Exports</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Connection:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun.open">gun:open(3)</a> - Open a connection to the given host and port -</p> +<p>Connection:</p> +<ul><li><a href="../gun.open">gun:open(3)</a> - Open a connection to the given host and port </li> -<li> -<p> -<a href="../gun.open_unix">gun:open_unix(3)</a> - Open a connection to the given Unix domain socket -</p> +<li><a href="../gun.open_unix">gun:open_unix(3)</a> - Open a connection to the given Unix domain socket </li> -<li> -<p> -<a href="../gun.close">gun:close(3)</a> - Brutally close the connection -</p> +</ul> +<!-- @todo * link:../gun.shutdown[gun:shutdown(3)] - Gracefully close the connection--> +<ul><li><a href="../gun.close">gun:close(3)</a> - Brutally close the connection </li> -<li> -<p> -<a href="../gun.info">gun:info(3)</a> - Obtain information about the connection -</p> +<li><a href="../gun.info">gun:info(3)</a> - Obtain information about the connection </li> -</ul></div> -<div class="paragraph"><p>Requests:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun.get">gun:get(3)</a> - Get a resource representation -</p> +</ul> +<p>Requests:</p> +<ul><li><a href="../gun.get">gun:get(3)</a> - Get a resource representation </li> -<li> -<p> -<a href="../gun.head">gun:head(3)</a> - Get headers of a resource representation -</p> +<li><a href="../gun.head">gun:head(3)</a> - Get headers of a resource representation </li> -<li> -<p> -<a href="../gun.options">gun:options(3)</a> - Query the capabilities of the server or a resource -</p> +<li><a href="../gun.options">gun:options(3)</a> - Query the capabilities of the server or a resource </li> -<li> -<p> -<a href="../gun.patch">gun:patch(3)</a> - Apply a set of changes to a resource -</p> +<li><a href="../gun.patch">gun:patch(3)</a> - Apply a set of changes to a resource </li> -<li> -<p> -<a href="../gun.post">gun:post(3)</a> - Process the enclosed representation according to a resource’s own semantics -</p> +<li><a href="../gun.post">gun:post(3)</a> - Process the enclosed representation according to a resource's own semantics </li> -<li> -<p> -<a href="../gun.put">gun:put(3)</a> - Create or replace a resource -</p> +<li><a href="../gun.put">gun:put(3)</a> - Create or replace a resource </li> -<li> -<p> -<a href="../gun.delete">gun:delete(3)</a> - Delete a resource -</p> +<li><a href="../gun.delete">gun:delete(3)</a> - Delete a resource </li> -<li> -<p> -<a href="../gun.request">gun:request(3)</a> - Perform the given request -</p> +<li><a href="../gun.request">gun:request(3)</a> - Perform the given request </li> -<li> -<p> -<a href="../gun.data">gun:data(3)</a> - Stream the body of a request -</p> +<li><a href="../gun.data">gun:data(3)</a> - Stream the body of a request </li> -</ul></div> -<div class="paragraph"><p>Messages:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun.await">gun:await(3)</a> - Wait for a response -</p> +</ul> +<p>Messages:</p> +<ul><li><a href="../gun.await">gun:await(3)</a> - Wait for a response </li> -<li> -<p> -<a href="../gun.await_body">gun:await_body(3)</a> - Wait for the complete response body -</p> +<li><a href="../gun.await_body">gun:await_body(3)</a> - Wait for the complete response body </li> -<li> -<p> -<a href="../gun.await_up">gun:await(3)</a> - Wait for the connection to be up -</p> +<li><a href="../gun.await_up">gun:await_up(3)</a> - Wait for the connection to be up </li> -<li> -<p> -<a href="../gun.flush">gun:flush(3)</a> - Flush all messages related to a connection or a stream -</p> +<li><a href="../gun.flush">gun:flush(3)</a> - Flush all messages related to a connection or a stream </li> -</ul></div> -<div class="paragraph"><p>Streams:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun.cancel">gun:cancel(3)</a> - Cancel the given stream -</p> +</ul> +<p>Streams:</p> +<ul><li><a href="../gun.cancel">gun:cancel(3)</a> - Cancel the given stream </li> -</ul></div> -<div class="paragraph"><p>Websocket:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a> - Upgrade to Websocket -</p> +</ul> +<p>Websocket:</p> +<ul><li><a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a> - Upgrade to Websocket </li> -<li> -<p> -<a href="../gun.ws_send">gun:ws_send(3)</a> - Send Websocket frames -</p> +<li><a href="../gun.ws_send">gun:ws_send(3)</a> - Send Websocket frames </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_messages">Messages</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun will inform the calling process of events asynchronously -by sending any of the following messages:</p></div> -<div class="paragraph"><p>Connection:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun_up">gun_up(3)</a> - The connection is up -</p> +<p>Gun will inform the calling process of events asynchronously by sending any of the following messages:</p> +<p>Connection:</p> +<ul><li><a href="../gun_up">gun_up(3)</a> - The connection is up </li> -<li> -<p> -<a href="../gun_down">gun_down(3)</a> - The connection is down -</p> +<li><a href="../gun_down">gun_down(3)</a> - The connection is down </li> -<li> -<p> -<a href="../gun_upgrade">gun_upgrade(3)</a> - Successful protocol upgrade -</p> +<li><a href="../gun_upgrade">gun_upgrade(3)</a> - Successful protocol upgrade </li> -<li> -<p> -<a href="../gun_error">gun_error(3)</a> - Stream or connection-wide error -</p> +<li><a href="../gun_error">gun_error(3)</a> - Stream or connection-wide error </li> -</ul></div> -<div class="paragraph"><p>Responses:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun_push">gun_push(3)</a> - Server-initiated push -</p> +</ul> +<p>Responses:</p> +<ul><li><a href="../gun_push">gun_push(3)</a> - Server-initiated push </li> -<li> -<p> -<a href="../gun_inform">gun_inform(3)</a> - Informational response -</p> +<li><a href="../gun_inform">gun_inform(3)</a> - Informational response </li> -<li> -<p> -<a href="../gun_response">gun_response(3)</a> - Response -</p> +<li><a href="../gun_response">gun_response(3)</a> - Response </li> -<li> -<p> -<a href="../gun_data">gun_data(3)</a> - Response body -</p> +<li><a href="../gun_data">gun_data(3)</a> - Response body </li> -<li> -<p> -<a href="../gun_trailers">gun_trailers(3)</a> - Response trailers -</p> +<li><a href="../gun_trailers">gun_trailers(3)</a> - Response trailers </li> -</ul></div> -<div class="paragraph"><p>Websocket:</p></div> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun_ws">gun_ws(3)</a> - Websocket frame -</p> +</ul> +<p>Websocket:</p> +<ul><li><a href="../gun_ws">gun_ws(3)</a> - Websocket frame </li> -</ul></div> -<div class="paragraph"><p>The response messages will be sent to the process that opened -the connection by default. The <code>reply_to</code> request option can -be used to redirect request-specific messages to a different -process.</p></div> -</div> -</div> -<div class="sect1"> +</ul> +<p>The response messages will be sent to the process that opened the connection by default. The <code>reply_to</code> request option can be used to redirect request-specific messages to a different process.</p> <h2 id="_types">Types</h2> -<div class="sectionbody"> -<div class="sect2"> <h3 id="_http_opts">http_opts()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">http_opts</span></span>() <span style="color: #990000">::</span> #{ - <span style="color: #0000FF">keepalive</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(), - <span style="color: #0000FF">transform_header_name</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #0000FF">fun</span></span>((<span style="font-weight: bold"><span style="color: #000080">binary</span></span>()) <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()), - <span style="color: #0000FF">version</span> <span style="color: #990000">=></span> <span style="color: #FF6600">'HTTP/1.1'</span> | <span style="color: #FF6600">'HTTP/1.0'</span> -}</tt></pre></div></div> -<div class="paragraph"><p>Configuration for the HTTP protocol.</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"> -keepalive (5000) -</dt> -<dd> -<p> -Time between pings in milliseconds. Since the HTTP protocol has -no standardized way to ping the server, Gun will simply send an -empty line when the connection is idle. Gun only makes a best -effort here as servers usually have configurable limits to drop -idle connections. Use <code>infinity</code> to disable. -</p> +<pre><tt><b><font color="#000000">http_opts</font></b>() <font color="#990000">::</font> #{ + <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> +<p>The default value is given next to the option name:</p> +<!-- @todo Document content_handlers and gun_sse_h.--> +<dl><dt>keepalive (5000)</dt> +<dd><p>Time between pings in milliseconds. Since the HTTP protocol has no standardized way to ping the server, Gun will simply send an empty line when the connection is idle. Gun only makes a best effort here as servers usually have configurable limits to drop idle connections. Use <code>infinity</code> to disable.</p> </dd> -<dt class="hdlist1"> -transform_header_name - see below -</dt> -<dd> -<p> -A function that will be applied to all header names before they -are sent to the server. Gun assumes that all header names are in -lower case. This function is useful if you, for example, need to -re-case header names in the event that the server incorrectly -considers the case of header names to be significant. -</p> +<dt>transform_header_name - see below</dt> +<dd><p>A function that will be applied to all header names before they are sent to the server. Gun assumes that all header names are in lower case. This function is useful if you, for example, need to re-case header names in the event that the server incorrectly considers the case of header names to be significant.</p> </dd> -<dt class="hdlist1"> -version (<code>'HTTP/1.1'</code>) -</dt> -<dd> -<p> -HTTP version to use. -</p> +<dt>version (<code>'HTTP/1.1'</code>)</dt> +<dd><p>HTTP version to use.</p> </dd> -</dl></div> -</div> -<div class="sect2"> +</dl> <h3 id="_http2_opts">http2_opts()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">http2_opts</span></span>() <span style="color: #990000">::</span> #{ - <span style="color: #0000FF">keepalive</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>() -}</tt></pre></div></div> -<div class="paragraph"><p>Configuration for the HTTP/2 protocol.</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"> -keepalive (5000) -</dt> -<dd> -<p> -Time between pings in milliseconds. -</p> +<pre><tt><b><font color="#000000">http2_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">keepalive</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the HTTP/2 protocol.</p> +<p>The default value is given next to the option name:</p> +<!-- @todo Document content_handlers and gun_sse_h.--> +<dl><dt>keepalive (5000)</dt> +<dd><p>Time between pings in milliseconds.</p> </dd> -</dl></div> -</div> -<div class="sect2"> +</dl> +<!-- @todo Allow and document max_frame_size_sent.--> <h3 id="_opts">opts()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">connect_timeout</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">timeout</span></span>(), - <span style="color: #0000FF">http_opts</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">http_opts</span></span>(), - <span style="color: #0000FF">http2_opts</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">http2_opts</span></span>(), - <span style="color: #0000FF">protocols</span> <span style="color: #990000">=></span> [<span style="color: #FF6600">http</span> | <span style="color: #FF6600">http2</span>], - <span style="color: #0000FF">retry</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), - <span style="color: #0000FF">retry_timeout</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">pos_integer</span></span>(), - <span style="color: #0000FF">trace</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">boolean</span></span>(), - <span style="color: #0000FF">transport</span> <span style="color: #990000">=></span> <span style="color: #FF6600">tcp</span> | <span style="color: #FF6600">tls</span>, - <span style="color: #0000FF">transport_opts</span> <span style="color: #990000">=></span> [<span style="font-weight: bold"><span style="color: #000000">gen_tcp:connect_option</span></span>()] | [<span style="font-weight: bold"><span style="color: #000000">ssl:connect_option</span></span>()], - <span style="color: #0000FF">ws_opts</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">ws_opts</span></span>() -}</tt></pre></div></div> -<div class="paragraph"><p>Configuration for the connection.</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"> -connect_timeout (infinity) -</dt> -<dd> -<p> -Connection timeout. -</p> +<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">connect_timeout</font> <font color="#990000">=></font> <b><font color="#000000">timeout</font></b>(), + <font color="#0000FF">http_opts</font> <font color="#990000">=></font> <b><font color="#000000">http_opts</font></b>(), + <font color="#0000FF">http2_opts</font> <font color="#990000">=></font> <b><font color="#000000">http2_opts</font></b>(), + <font color="#0000FF">protocols</font> <font color="#990000">=></font> [<font color="#FF6600">http</font> | <font color="#FF6600">http2</font>], + <font color="#0000FF">retry</font> <font color="#990000">=></font> <b><font color="#000000">non_neg_integer</font></b>(), + <font color="#0000FF">retry_timeout</font> <font color="#990000">=></font> <b><font color="#000000">pos_integer</font></b>(), + <font color="#0000FF">trace</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>(), + <font color="#0000FF">transport</font> <font color="#990000">=></font> <font color="#FF6600">tcp</font> | <font color="#FF6600">tls</font>, + <font color="#0000FF">transport_opts</font> <font color="#990000">=></font> [<b><font color="#000000">gen_tcp:connect_option</font></b>()] | [<b><font color="#000000">ssl:connect_option</font></b>()], + <font color="#0000FF">ws_opts</font> <font color="#990000">=></font> <b><font color="#000000">ws_opts</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the connection.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>connect_timeout (infinity)</dt> +<dd><p>Connection timeout.</p> </dd> -<dt class="hdlist1"> -http_opts (#{}) -</dt> -<dd> -<p> -Options specific to the HTTP protocol. -</p> +<dt>http_opts (#{})</dt> +<dd><p>Options specific to the HTTP protocol.</p> </dd> -<dt class="hdlist1"> -http2_opts (#{}) -</dt> -<dd> -<p> -Options specific to the HTTP/2 protocol. -</p> +<dt>http2_opts (#{})</dt> +<dd><p>Options specific to the HTTP/2 protocol.</p> </dd> -<dt class="hdlist1"> -protocols - see below -</dt> -<dd> -<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 always be used. 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> +<dt>protocols - see below</dt> +<dd><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 always be used. 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> </dd> -<dt class="hdlist1"> -retry (5) -</dt> -<dd> -<p> -Number of times Gun will try to reconnect on failure before giving up. -</p> +<dt>retry (5)</dt> +<dd><p>Number of times Gun will try to reconnect on failure before giving up.</p> </dd> -<dt class="hdlist1"> -retry_timeout (5000) -</dt> -<dd> -<p> -Time between retries in milliseconds. -</p> +<dt>retry_timeout (5000)</dt> +<dd><p>Time between retries in milliseconds.</p> </dd> -<dt class="hdlist1"> -trace (false) -</dt> -<dd> -<p> -Whether to enable <code>dbg</code> tracing of the connection process. Should -only be used during debugging. -</p> +<dt>trace (false)</dt> +<dd><p>Whether to enable <code>dbg</code> tracing of the connection process. Should only be used during debugging.</p> </dd> -<dt class="hdlist1"> -transport - see below -</dt> -<dd> -<p> -Whether to use TLS or plain TCP. The default varies depending on the -port used. Port 443 defaults to <code>tls</code>. All other ports default to <code>tcp</code>. -</p> +<dt>transport - see below</dt> +<dd><p>Whether to use TLS or plain TCP. The default varies depending on the port used. Port 443 defaults to <code>tls</code>. All other ports default to <code>tcp</code>.</p> </dd> -<dt class="hdlist1"> -transport_opts ([]) -</dt> -<dd> -<p> -Transport options. They are TCP options or TLS options depending on -the selected transport. -</p> +<dt>transport_opts ([])</dt> +<dd><p>Transport options. They are TCP options or TLS options depending on the selected transport.</p> </dd> -<dt class="hdlist1"> -ws_opts (#{}) -</dt> -<dd> -<p> -Options specific to the Websocket protocol. -</p> +<dt>ws_opts (#{})</dt> +<dd><p>Options specific to the Websocket protocol.</p> </dd> -</dl></div> -</div> -<div class="sect2"> +</dl> <h3 id="_req_opts">req_opts()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">req_opts</span></span>() <span style="color: #990000">::</span> #{ - <span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -}</tt></pre></div></div> -<div class="paragraph"><p>Configuration for a particular request.</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"> -reply_to (<code>self()</code>) -</dt> -<dd> -<p> -The pid of the process that will receive the response messages. -</p> +<pre><tt><b><font color="#000000">req_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <b><font color="#000080">pid</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for a particular request.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>reply_to (<code>self()</code>)</dt> +<dd><p>The pid of the process that will receive the response messages.</p> </dd> -</dl></div> -</div> -<div class="sect2"> +</dl> <h3 id="_ws_opts">ws_opts()</h3> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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">ws_opts</span></span>() <span style="color: #990000">::</span> #{ - <span style="color: #0000FF">compress</span> <span style="color: #990000">=></span> <span style="font-weight: bold"><span style="color: #000000">boolean</span></span>() -}</tt></pre></div></div> -<div class="paragraph"><p>Configuration for the Websocket protocol.</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"> -compress ⇒ boolean() -</dt> -<dd> -<p> -Whether to enable permessage-deflate compression. This does -not guarantee that compression will be used as it is the -server that ultimately decides. Defaults to false. -</p> +<pre><tt><b><font color="#000000">ws_opts</font></b>() <font color="#990000">::</font> #{ + <font color="#0000FF">compress</font> <font color="#990000">=></font> <b><font color="#000000">boolean</font></b>() +}</tt></pre> +</div></div> +<p>Configuration for the Websocket protocol.</p> +<p>The default value is given next to the option name:</p> +<dl><dt>compress => boolean()</dt> +<dd><p>Whether to enable permessage-deflate compression. This does not guarantee that compression will be used as it is the server that ultimately decides. Defaults to false.</p> </dd> -</dl></div> -</div> -</div> -</div> -<div class="sect1"> +</dl> +<!-- @todo Document default_protocol, protocols and user_opts.--> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="..">gun(7)</a></p></div> -</div> -</div> +<p><a href="..">gun(7)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_app/index.html b/docs/en/gun/1.0/manual/gun_app/index.html index de6942c4..d1706ea0 100644 --- a/docs/en/gun/1.0/manual/gun_app/index.html +++ b/docs/en/gun/1.0/manual/gun_app/index.html @@ -62,72 +62,33 @@ <h1 class="lined-header"><span>gun(7)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p></div> -</div> -</div> -<div class="sect1"> +<p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun is an HTTP client for Erlang/OTP with support for the -HTTP/1.1, HTTP/2 and Websocket protocols.</p></div> -<div class="paragraph"><p>Gun aims to provide an easy to use, asynchronous and -always-connected client. It maintains a permanent connection -to the server and reconnects automatically when necessary.</p></div> -</div> -</div> -<div class="sect1"> +<p>Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.</p> <h2 id="_modules">Modules</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="../gun">gun(3)</a> - Asynchronous HTTP client -</p> +<ul><li><a href="../gun">gun(3)</a> - Asynchronous HTTP client </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_dependencies">Dependencies</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="../cowlib">cowlib(7)</a> - Support library for manipulating Web protocols -</p> +<ul><li><a href="../cowlib">cowlib(7)</a> - Support library for manipulating Web protocols </li> -<li> -<p> -ssl - Secure communication over sockets -</p> +<li>ssl - Secure communication over sockets </li> -</ul></div> -<div class="paragraph"><p>All these applications must be started before the <code>gun</code> -application. To start Gun and all dependencies at once:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +</ul> +<p>All these applications must be started before the <code>gun</code> application. To start Gun and all dependencies at once:</p> +<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="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">gun</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_environment">Environment</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>gun</code> application does not define any application -environment configuration parameters.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <code>gun</code> application does not define any application environment configuration parameters.</p> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../cowlib">cowlib(7)</a></p></div> -</div> -</div> +<p><a href="../cowlib">cowlib(7)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_data/index.html b/docs/en/gun/1.0/manual/gun_data/index.html index 31da2d23..bc3a5dc4 100644 --- a/docs/en/gun/1.0/manual/gun_data/index.html +++ b/docs/en/gun/1.0/manual/gun_data/index.html @@ -62,119 +62,57 @@ <h1 class="lined-header"><span>gun_data(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_data - Response body</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_data - Response body</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_data</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">IsFin</span>, <span style="color: #009900">Data</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">IsFin</span> <span style="color: #990000">::</span> <span style="color: #FF6600">fin</span> | <span style="color: #FF6600">nofin</span> -<span style="color: #009900">Data</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Response body.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -sent a all or part of the body for the response to the -original request.</p></div> -<div class="paragraph"><p>A data message is always preceded by a response message.</p></div> -<div class="paragraph"><p>The response body may be terminated either by a data -message with the flag <code>fin</code> set or by a -<a href="../gun_trailers">gun_trailers(3)</a> message.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Data</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Data</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>()</tt></pre> +</div></div> +<p>Response body.</p> +<p>This message informs the relevant process that the server sent a all or part of the body for the response to the original request.</p> +<p>A data message is always preceded by a response message.</p> +<p>The response body may be terminated either by a data message with the flag <code>fin</code> set or by a <a href="../gun_trailers">gun_trailers(3)</a> message.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -IsFin -</dt> -<dd> -<p> -Whether this message terminates the response. -</p> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the response.</p> </dd> -<dt class="hdlist1"> -Data -</dt> -<dd> -<p> -All or part of the response body. -</p> +<dt>Data</dt> +<dd><p>All or part of the response body.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_data message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_data message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_data</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, - <span style="color: #009900">_IsFin</span>, <span style="color: #009900">_Data</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_data</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_IsFin</font>, <font color="#009900">_Data</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.delete">gun:delete(3)</a>, -<a href="../gun.options">gun:options(3)</a>, -<a href="../gun.request">gun:request(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_trailers">gun_trailers(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_trailers">gun_trailers(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_down/index.html b/docs/en/gun/1.0/manual/gun_down/index.html index ddc7c7e1..40698e50 100644 --- a/docs/en/gun/1.0/manual/gun_down/index.html +++ b/docs/en/gun/1.0/manual/gun_down/index.html @@ -62,130 +62,63 @@ <h1 class="lined-header"><span>gun_down(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_down - The connection is down</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_down - The connection is down</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_down</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Protocol</span>, <span style="color: #009900">Reason</span>, <span style="color: #009900">KilledStreams</span>, <span style="color: #009900">UnprocessedStreams</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Protocol</span> <span style="color: #990000">::</span> <span style="color: #FF6600">http</span> | <span style="color: #FF6600">http2</span> | <span style="color: #FF6600">ws</span> -<span style="color: #009900">Reason</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">any</span></span>() -<span style="color: #009900">KilledStreams</span> <span style="color: #990000">::</span> [<span style="font-weight: bold"><span style="color: #000080">reference</span></span>()] -<span style="color: #009900">UnprocessedStreams</span> <span style="color: #990000">::</span> [<span style="font-weight: bold"><span style="color: #000080">reference</span></span>()]</tt></pre></div></div> -<div class="paragraph"><p>The connection is down.</p></div> -<div class="paragraph"><p>This message informs the owner process that the connection -was lost. Depending on the <code>retry</code> and <code>retry_timeout</code> -options Gun may automatically attempt to reconnect.</p></div> -<div class="paragraph"><p>When the connection goes back up, Gun will not attempt to retry -requests. It will also not upgrade to Websocket automatically -if that was the protocol in use when the connection was lost.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_down</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>, <font color="#009900">Reason</font>, <font color="#009900">KilledStreams</font>, <font color="#009900">UnprocessedStreams</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font> | <font color="#FF6600">ws</font> +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>() +<font color="#009900">KilledStreams</font> <font color="#990000">::</font> [<b><font color="#000080">reference</font></b>()] +<font color="#009900">UnprocessedStreams</font> <font color="#990000">::</font> [<b><font color="#000080">reference</font></b>()]</tt></pre> +</div></div> +<p>The connection is down.</p> +<p>This message informs the owner process that the connection was lost. Depending on the <code>retry</code> and <code>retry_timeout</code> options Gun may automatically attempt to reconnect.</p> +<p>When the connection goes back up, Gun will not attempt to retry requests. It will also not upgrade to Websocket automatically if that was the protocol in use when the connection was lost.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Protocol -</dt> -<dd> -<p> -The protocol that was selected for this connection -or upgraded to during the course of the connection. -</p> +<dt>Protocol</dt> +<dd><p>The protocol that was selected for this connection or upgraded to during the course of the connection.</p> </dd> -<dt class="hdlist1"> -Reason -</dt> -<dd> -<p> -The reason for the loss of the connection. -</p> -<div class="paragraph"><p>It is present for debugging purposes only. You should not -rely on this value to perform operations programmatically.</p></div> +<dt>Reason</dt> +<dd><p>The reason for the loss of the connection.</p> +<p>It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.</p> </dd> -<dt class="hdlist1"> -KilledStreams -</dt> -<dd> -<p> -List of streams that have been brutally terminated. -</p> -<div class="paragraph"><p>They are active streams that did not complete before the closing -of the connection. Whether they can be retried safely depends -on the protocol used and the idempotence property of the requests.</p></div> +<dt>KilledStreams</dt> +<dd><p>List of streams that have been brutally terminated.</p> +<p>They are active streams that did not complete before the closing of the connection. Whether they can be retried safely depends on the protocol used and the idempotence property of the requests.</p> </dd> -<dt class="hdlist1"> -UnprocessedStreams -</dt> -<dd> -<p> -List of streams that have not been processed by the server. -</p> -<div class="paragraph"><p>They are streams that the server did not start processing yet. -They may be retried safely depending on whether related streams -were killed.</p></div> +<dt>UnprocessedStreams</dt> +<dd><p>List of streams that have not been processed by the server.</p> +<p>They are streams that the server did not start processing yet. They may be retried safely depending on whether related streams were killed.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_down message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_down message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_down</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_Protocol</span>, - <span style="color: #009900">_Reason</span>, <span style="color: #009900">_Killed</span>, <span style="color: #009900">_Unprocessed</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_down</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>, + <font color="#009900">_Reason</font>, <font color="#009900">_Killed</font>, <font color="#009900">_Unprocessed</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a>, -<a href="../gun_up">gun_up(3)</a>, -<a href="../gun_error">gun_error(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_error/index.html b/docs/en/gun/1.0/manual/gun_error/index.html index 1d8499d3..10e9462c 100644 --- a/docs/en/gun/1.0/manual/gun_error/index.html +++ b/docs/en/gun/1.0/manual/gun_error/index.html @@ -62,106 +62,56 @@ <h1 class="lined-header"><span>gun_error(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_error - Stream or connection-wide error</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_error - Stream or connection-wide error</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_error</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Reason</span>} -{<span style="color: #FF6600">gun_error</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Reason</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">Reason</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">any</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Stream or connection-wide error.</p></div> -<div class="paragraph"><p>These messages inform the relevant process that an error -occurred. A reference is given when the error pertains -to a specific stream. Connection-wide errors do not -imply that the connection is no longer usable, they are -used for all errors that are not specific to a stream.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Reason</font>} +{<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Reason</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre> +</div></div> +<p>Stream or connection-wide error.</p> +<p>These messages inform the relevant process that an error occurred. A reference is given when the error pertains to a specific stream. Connection-wide errors do not imply that the connection is no longer usable, they are used for all errors that are not specific to a stream.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream that resulted in an error. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that resulted in an error.</p> </dd> -<dt class="hdlist1"> -Reason -</dt> -<dd> -<p> -The reason for the error. -</p> -<div class="paragraph"><p>It is present for debugging purposes only. You should not -rely on this value to perform operations programmatically.</p></div> +<dt>Reason</dt> +<dd><p>The reason for the error.</p> +<p>It is present for debugging purposes only. You should not rely on this value to perform operations programmatically.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_error message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_error message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_error</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_Reason</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}; -<span style="font-weight: bold"><span style="color: #000000">handle_info</span></span>({<span style="color: #FF6600">gun_error</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, <span style="color: #009900">_Reason</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Reason</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}; +<b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_error</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Reason</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun_up">gun_up(3)</a>, -<a href="../gun_down">gun_down(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun_up">gun_up(3)</a>, <a href="../gun_down">gun_down(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_inform/index.html b/docs/en/gun/1.0/manual/gun_inform/index.html index 7f04b59b..b2970f53 100644 --- a/docs/en/gun/1.0/manual/gun_inform/index.html +++ b/docs/en/gun/1.0/manual/gun_inform/index.html @@ -62,113 +62,56 @@ <h1 class="lined-header"><span>gun_inform(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_inform - Informational response</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_inform - Informational response</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_inform</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">Status</span> <span style="color: #990000">::</span> <span style="color: #993399">100</span><span style="color: #990000">..</span><span style="color: #993399">199</span> -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}]</tt></pre></div></div> -<div class="paragraph"><p>Informational response.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -sent an informational response to the original request.</p></div> -<div class="paragraph"><p>Informational responses are only intermediate responses -and provide no guarantees as to what the final response -will be. An informational response always precedes the -response to the original request.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_inform</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Status</font> <font color="#990000">::</font> <font color="#993399">100</font><font color="#990000">..</font><font color="#993399">199</font> +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Informational response.</p> +<p>This message informs the relevant process that the server sent an informational response to the original request.</p> +<p>Informational responses are only intermediate responses and provide no guarantees as to what the final response will be. An informational response always precedes the response to the original request.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -Status -</dt> -<dd> -<p> -Status code for the informational response. -</p> +<dt>Status</dt> +<dd><p>Status code for the informational response.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Headers sent with the informational response. -</p> +<dt>Headers</dt> +<dd><p>Headers sent with the informational response.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_inform message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_inform message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_inform</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, - <span style="color: #009900">_Status</span>, <span style="color: #009900">_Headers</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_inform</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_Status</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun_response">gun_response(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_push/index.html b/docs/en/gun/1.0/manual/gun_push/index.html index 86229224..15075e15 100644 --- a/docs/en/gun/1.0/manual/gun_push/index.html +++ b/docs/en/gun/1.0/manual/gun_push/index.html @@ -62,141 +62,76 @@ <h1 class="lined-header"><span>gun_push(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_push - Server-initiated push</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_push - Server-initiated push</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_push</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">NewStreamRef</span>, <span style="color: #009900">Method</span>, <span style="color: #009900">URI</span>, <span style="color: #009900">Headers</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">NewStreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">Method</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">binary</span></span>() -<span style="color: #009900">URI</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">binary</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}]</tt></pre></div></div> -<div class="paragraph"><p>Server-initiated push.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -is pushing a resource related to the effective target URI -of the original request.</p></div> -<div class="paragraph"><p>A server-initiated push message always precedes the response -to the original request.</p></div> -<div class="paragraph"><p>This message will not be sent when using the HTTP/1.1 protocol -because it lacks the concept of server-initiated push.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">NewStreamRef</font>, <font color="#009900">Method</font>, <font color="#009900">URI</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">NewStreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Method</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Server-initiated push.</p> +<p>This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request.</p> +<p>A server-initiated push message always precedes the response to the original request.</p> +<p>This message will not be sent when using the HTTP/1.1 protocol because it lacks the concept of server-initiated push.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -NewStreamRef -</dt> -<dd> -<p> -Identifier of the stream being pushed. -</p> +<dt>NewStreamRef</dt> +<dd><p>Identifier of the stream being pushed.</p> </dd> -<dt class="hdlist1"> -Method -</dt> -<dd> -<p> -Method of the equivalent HTTP request. -</p> +<dt>Method</dt> +<dd><p>Method of the equivalent HTTP request.</p> </dd> -<dt class="hdlist1"> -URI -</dt> -<dd> -<p> -URI of the resource being pushed. -</p> +<dt>URI</dt> +<dd><p>URI of the resource being pushed.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Headers of the equivalent HTTP request. -</p> +<dt>Headers</dt> +<dd><p>Headers of the equivalent HTTP request.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_push message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_push message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_push</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, - <span style="color: #009900">_NewStreamRef</span>, <span style="color: #009900">_Method</span>, <span style="color: #009900">_URI</span>, <span style="color: #009900">_Headers</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Cancel an unwanted push</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_NewStreamRef</font>, <font color="#009900">_Method</font>, <font color="#009900">_URI</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Cancel an unwanted push</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_push</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, - <span style="color: #009900">NewStreamRef</span>, <span style="color: #009900">_Method</span>, <span style="color: #009900">_URI</span>, <span style="color: #009900">_Headers</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-weight: bold"><span style="color: #000000">gun:cancel</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">NewStreamRef</span>), - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_push</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">NewStreamRef</font>, <font color="#009900">_Method</font>, <font color="#009900">_URI</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <b><font color="#000000">gun:cancel</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">NewStreamRef</font>), + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.cancel">gun:cancel(3)</a>, -<a href="../gun_response">gun_response(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.cancel">gun:cancel(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_response/index.html b/docs/en/gun/1.0/manual/gun_response/index.html index 379142ba..52a9e5d3 100644 --- a/docs/en/gun/1.0/manual/gun_response/index.html +++ b/docs/en/gun/1.0/manual/gun_response/index.html @@ -62,123 +62,59 @@ <h1 class="lined-header"><span>gun_response(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_response - Response</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_response - Response</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_response</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">IsFin</span>, <span style="color: #009900">Status</span>, <span style="color: #009900">Headers</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">IsFin</span> <span style="color: #990000">::</span> <span style="color: #FF6600">fin</span> | <span style="color: #FF6600">nofin</span> -<span style="color: #009900">Status</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}]</tt></pre></div></div> -<div class="paragraph"><p>Response.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -sent a response to the original request.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">IsFin</font>, <font color="#009900">Status</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">IsFin</font> <font color="#990000">::</font> <font color="#FF6600">fin</font> | <font color="#FF6600">nofin</font> +<font color="#009900">Status</font> <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Response.</p> +<p>This message informs the relevant process that the server sent a response to the original request.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -IsFin -</dt> -<dd> -<p> -Whether this message terminates the response. -</p> +<dt>IsFin</dt> +<dd><p>Whether this message terminates the response.</p> </dd> -<dt class="hdlist1"> -Status -</dt> -<dd> -<p> -Status code for the response. -</p> +<dt>Status</dt> +<dd><p>Status code for the response.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Headers sent with the response. -</p> +<dt>Headers</dt> +<dd><p>Headers sent with the response.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_response message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_response message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_response</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, - <span style="color: #009900">_IsFin</span>, <span style="color: #009900">_Status</span>, <span style="color: #009900">_Headers</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_response</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_IsFin</font>, <font color="#009900">_Status</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.delete">gun:delete(3)</a>, -<a href="../gun.options">gun:options(3)</a>, -<a href="../gun.request">gun:request(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_push">gun_push(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_push">gun_push(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_trailers/index.html b/docs/en/gun/1.0/manual/gun_trailers/index.html index e67b0afb..d78678c4 100644 --- a/docs/en/gun/1.0/manual/gun_trailers/index.html +++ b/docs/en/gun/1.0/manual/gun_trailers/index.html @@ -62,106 +62,51 @@ <h1 class="lined-header"><span>gun_trailers(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_trailers - Response trailers</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_trailers - Response trailers</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_trailers</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Headers</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}]</tt></pre></div></div> -<div class="paragraph"><p>Response trailers.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -sent response trailers for the response to the original -request.</p></div> -<div class="paragraph"><p>A trailers message terminates the response.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_trailers</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Response trailers.</p> +<p>This message informs the relevant process that the server sent response trailers for the response to the original request.</p> +<p>A trailers message terminates the response.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream for the original request. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream for the original request.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Trailing headers sent after the response body. -</p> +<dt>Headers</dt> +<dd><p>Trailing headers sent after the response body.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_trailers message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_trailers message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_trailers</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, <span style="color: #009900">_Headers</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_trailers</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:get(3)</a>, -<a href="../gun.head">gun:head(3)</a>, -<a href="../gun.patch">gun:patch(3)</a>, -<a href="../gun.post">gun:post(3)</a>, -<a href="../gun.put">gun:put(3)</a>, -<a href="../gun.delete">gun:delete(3)</a>, -<a href="../gun.options">gun:options(3)</a>, -<a href="../gun.request">gun:request(3)</a>, -<a href="../gun_response">gun_response(3)</a>, -<a href="../gun_data">gun_data(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:get(3)</a>, <a href="../gun.head">gun:head(3)</a>, <a href="../gun.patch">gun:patch(3)</a>, <a href="../gun.post">gun:post(3)</a>, <a href="../gun.put">gun:put(3)</a>, <a href="../gun.delete">gun:delete(3)</a>, <a href="../gun.options">gun:options(3)</a>, <a href="../gun.request">gun:request(3)</a>, <a href="../gun_response">gun_response(3)</a>, <a href="../gun_data">gun_data(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_up/index.html b/docs/en/gun/1.0/manual/gun_up/index.html index ea61a339..0d0257ba 100644 --- a/docs/en/gun/1.0/manual/gun_up/index.html +++ b/docs/en/gun/1.0/manual/gun_up/index.html @@ -62,96 +62,47 @@ <h1 class="lined-header"><span>gun_up(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_up - The connection is up</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_up - The connection is up</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_up</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">Protocol</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Protocol</span> <span style="color: #990000">::</span> <span style="color: #FF6600">http</span> | <span style="color: #FF6600">http2</span></tt></pre></div></div> -<div class="paragraph"><p>The connection is up.</p></div> -<div class="paragraph"><p>This message informs the owner process that the connection or -reconnection completed.</p></div> -<div class="paragraph"><p>Gun will now start processing the messages it received while -waiting for the connection to be up. If this is a reconnection, -then this may not be desirable for all requests. Those requests -should be cancelled when the connection goes down, and any -subsequent messages ignored.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">Protocol</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Protocol</font> <font color="#990000">::</font> <font color="#FF6600">http</font> | <font color="#FF6600">http2</font></tt></pre> +</div></div> +<p>The connection is up.</p> +<p>This message informs the owner process that the connection or reconnection completed.</p> +<p>Gun will now start processing the messages it received while waiting for the connection to be up. If this is a reconnection, then this may not be desirable for all requests. Those requests should be cancelled when the connection goes down, and any subsequent messages ignored.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Protocol -</dt> -<dd> -<p> -The protocol selected for this connection. It can be used -to determine the capabilities of the server. -</p> +<dt>Protocol</dt> +<dd><p>The protocol selected for this connection. It can be used to determine the capabilities of the server.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_up message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_up message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_up</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_Protocol</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_up</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_Protocol</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.open">gun:open(3)</a>, -<a href="../gun.open_unix">gun:open_unix(3)</a>, -<a href="../gun.await_up">gun:await_up(3)</a>, -<a href="../gun_down">gun_down(3)</a>, -<a href="../gun_error">gun_error(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.open">gun:open(3)</a>, <a href="../gun.open_unix">gun:open_unix(3)</a>, <a href="../gun.await_up">gun:await_up(3)</a>, <a href="../gun_down">gun_down(3)</a>, <a href="../gun_error">gun_error(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_upgrade/index.html b/docs/en/gun/1.0/manual/gun_upgrade/index.html index 56e8e569..ec4fdff2 100644 --- a/docs/en/gun/1.0/manual/gun_upgrade/index.html +++ b/docs/en/gun/1.0/manual/gun_upgrade/index.html @@ -62,114 +62,57 @@ <h1 class="lined-header"><span>gun_upgrade(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_upgrade - Successful protocol upgrade</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_upgrade - Successful protocol upgrade</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_upgrade</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Protocols</span>, <span style="color: #009900">Headers</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">Protocols</span> <span style="color: #990000">::</span> [<span style="color: #990000"><<</span><span style="color: #FF0000">"websocket"</span><span style="color: #990000">>></span>] -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}]</tt></pre></div></div> -<div class="paragraph"><p>Successful protocol upgrade.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -accepted to upgrade to one or more protocols given in the -original request.</p></div> -<div class="paragraph"><p>The exact semantics of this message depend on the original -protocol. HTTP/1.1 upgrades apply to the entire connection. -HTTP/2 uses a different mechanism which allows switching -specific streams to a different protocol.</p></div> -<div class="paragraph"><p>Gun currently only supports upgrading HTTP/1.1 connections -to the Websocket protocol.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Protocols</font>, <font color="#009900">Headers</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Protocols</font> <font color="#990000">::</font> [<font color="#990000"><<</font><font color="#FF0000">"websocket"</font><font color="#990000">>></font>] +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}]</tt></pre> +</div></div> +<p>Successful protocol upgrade.</p> +<p>This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request.</p> +<p>The exact semantics of this message depend on the original protocol. HTTP/1.1 upgrades apply to the entire connection. HTTP/2 uses a different mechanism which allows switching specific streams to a different protocol.</p> +<p>Gun currently only supports upgrading HTTP/1.1 connections to the Websocket protocol.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream that resulted in an upgrade. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that resulted in an upgrade.</p> </dd> -<dt class="hdlist1"> -Protocols -</dt> -<dd> -<p> -List of protocols this stream was upgraded to. -</p> +<dt>Protocols</dt> +<dd><p>List of protocols this stream was upgraded to.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Headers sent with the upgrade response. -</p> +<dt>Headers</dt> +<dd><p>Headers sent with the upgrade response.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_upgrade message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_upgrade message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_upgrade</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, - <span style="color: #009900">_Protocols</span>, <span style="color: #009900">_Headers</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_upgrade</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, + <font color="#009900">_Protocols</font>, <font color="#009900">_Headers</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, -<a href="../gun.ws_send">gun:ws_send(3)</a>, -<a href="../gun_ws">gun_ws(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_ws">gun_ws(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/gun_ws/index.html b/docs/en/gun/1.0/manual/gun_ws/index.html index e7eb4125..447fdc63 100644 --- a/docs/en/gun/1.0/manual/gun_ws/index.html +++ b/docs/en/gun/1.0/manual/gun_ws/index.html @@ -62,101 +62,53 @@ <h1 class="lined-header"><span>gun_ws(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun_ws - Websocket frame</p></div> -</div> -</div> -<div class="sect1"> +<p>gun_ws - Websocket frame</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<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="color: #FF6600">gun_ws</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">StreamRef</span>, <span style="color: #009900">Frame</span>} - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>() -<span style="color: #009900">Frame</span> <span style="color: #990000">::</span> <span style="color: #FF6600">close</span> - | {<span style="color: #FF6600">text</span> | <span style="font-weight: bold"><span style="color: #000080">binary</span></span> | <span style="color: #FF6600">close</span>, <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()} - | {<span style="color: #FF6600">close</span>, <span style="font-weight: bold"><span style="color: #000000">non_neg_integer</span></span>(), <span style="font-weight: bold"><span style="color: #000080">binary</span></span>()}</tt></pre></div></div> -<div class="paragraph"><p>Websocket frame.</p></div> -<div class="paragraph"><p>This message informs the relevant process that the server -sent the enclosed frame.</p></div> -<div class="paragraph"><p>This message can only be sent on streams that were upgraded -to the Websocket protocol.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">StreamRef</font>, <font color="#009900">Frame</font>} + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>() +<font color="#009900">Frame</font> <font color="#990000">::</font> <font color="#FF6600">close</font> + | {<font color="#FF6600">text</font> | <b><font color="#000080">binary</font></b> | <font color="#FF6600">close</font>, <b><font color="#000080">binary</font></b>()} + | {<font color="#FF6600">close</font>, <b><font color="#000000">non_neg_integer</font></b>(), <b><font color="#000080">binary</font></b>()}</tt></pre> +</div></div> +<p>Websocket frame.</p> +<p>This message informs the relevant process that the server sent the enclosed frame.</p> +<p>This message can only be sent on streams that were upgraded to the Websocket protocol.</p> <h2 id="_elements">Elements</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -StreamRef -</dt> -<dd> -<p> -Identifier of the stream that was upgraded to Websocket. -</p> +<dt>StreamRef</dt> +<dd><p>Identifier of the stream that was upgraded to Websocket.</p> </dd> -<dt class="hdlist1"> -Frame -</dt> -<dd> -<p> -The Websocket frame in question. -</p> +<dt>Frame</dt> +<dd><p>The Websocket frame in question.</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>1.0</strong>: Message introduced. -</p> +<ul><li><strong>1.0</strong>: Message introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Receive a gun_ws message in a gen_server</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Receive a gun_ws message in a gen_server</div> +<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">handle_info</span></span>({<span style="color: #FF6600">gun_ws</span>, <span style="color: #009900">ConnPid</span>, <span style="color: #009900">_StreamRef</span>, <span style="color: #009900">_Frame</span>}, - <span style="color: #009900">State</span><span style="color: #990000">=</span><span style="color: #008080">#state</span>{<span style="color: #0000FF">conn_pid</span><span style="color: #990000">=</span><span style="color: #009900">ConnPid</span>}) <span style="color: #990000">-></span> - <span style="font-style: italic"><span style="color: #9A1900">%% Do something.</span></span> - {<span style="color: #FF6600">noreply</span>, <span style="color: #009900">State</span>}<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">handle_info</font></b>({<font color="#FF6600">gun_ws</font>, <font color="#009900">ConnPid</font>, <font color="#009900">_StreamRef</font>, <font color="#009900">_Frame</font>}, + <font color="#009900">State</font><font color="#990000">=</font><font color="#008080">#state</font>{<font color="#0000FF">conn_pid</font><font color="#990000">=</font><font color="#009900">ConnPid</font>}) <font color="#990000">-></font> + <i><font color="#9A1900">%% Do something.</font></i> + {<font color="#FF6600">noreply</font>, <font color="#009900">State</font>}<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, -<a href="../gun.ws_send">gun:ws_send(3)</a>, -<a href="../gun_upgrade">gun_upgrade(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.ws_upgrade">gun:ws_upgrade(3)</a>, <a href="../gun.ws_send">gun:ws_send(3)</a>, <a href="../gun_upgrade">gun_upgrade(3)</a></p> + diff --git a/docs/en/gun/1.0/manual/index.html b/docs/en/gun/1.0/manual/index.html index 241ed25e..96bf8528 100644 --- a/docs/en/gun/1.0/manual/index.html +++ b/docs/en/gun/1.0/manual/index.html @@ -62,72 +62,33 @@ <h1 class="lined-header"><span>Gun Function Reference</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p></div> -</div> -</div> -<div class="sect1"> +<p>gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Gun is an HTTP client for Erlang/OTP with support for the -HTTP/1.1, HTTP/2 and Websocket protocols.</p></div> -<div class="paragraph"><p>Gun aims to provide an easy to use, asynchronous and -always-connected client. It maintains a permanent connection -to the server and reconnects automatically when necessary.</p></div> -</div> -</div> -<div class="sect1"> +<p>Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols.</p> +<p>Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary.</p> <h2 id="_modules">Modules</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="gun">gun(3)</a> - Asynchronous HTTP client -</p> +<ul><li><a href="gun">gun(3)</a> - Asynchronous HTTP client </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_dependencies">Dependencies</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols -</p> +<ul><li><a href="cowlib_app">cowlib(7)</a> - Support library for manipulating Web protocols </li> -<li> -<p> -ssl - Secure communication over sockets -</p> +<li>ssl - Secure communication over sockets </li> -</ul></div> -<div class="paragraph"><p>All these applications must be started before the <code>gun</code> -application. To start Gun and all dependencies at once:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +</ul> +<p>All these applications must be started before the <code>gun</code> application. To start Gun and all dependencies at once:</p> +<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="color: #FF6600">ok</span>, <span style="color: #990000">_</span>} <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">application:ensure_all_started</span></span>(<span style="color: #FF6600">gun</span>)<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt>{<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">application:ensure_all_started</font></b>(<font color="#FF6600">gun</font>)<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_environment">Environment</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>gun</code> application does not define any application -environment configuration parameters.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <code>gun</code> application does not define any application environment configuration parameters.</p> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="cowlib_app">cowlib(7)</a></p></div> -</div> -</div> +<p><a href="cowlib_app">cowlib(7)</a></p> + |