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/1.0/manual/gun_error/index.html | |
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/1.0/manual/gun_error/index.html')
-rw-r--r-- | docs/en/gun/1.0/manual/gun_error/index.html | 118 |
1 files changed, 34 insertions, 84 deletions
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> + |