summaryrefslogtreecommitdiffstats
path: root/docs/en/gun/1.0/manual/gun_down/index.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-13 09:54:12 +0200
committerLoïc Hoguin <[email protected]>2018-06-13 09:54:12 +0200
commit92b54aacc0de5446dd5497c39897b0bbff72e626 (patch)
treec3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/gun/1.0/manual/gun_down/index.html
parent8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff)
downloadninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz
ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2
ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip
Rebuild using Asciideck
Diffstat (limited to 'docs/en/gun/1.0/manual/gun_down/index.html')
-rw-r--r--docs/en/gun/1.0/manual/gun_down/index.html145
1 files changed, 39 insertions, 106 deletions
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">-&gt;</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">-&gt;</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>
+