diff options
Diffstat (limited to 'docs/en/gun/1.0/manual/gun.flush/index.html')
| -rw-r--r-- | docs/en/gun/1.0/manual/gun.flush/index.html | 99 |
1 files changed, 27 insertions, 72 deletions
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> + |