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.await_up/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.await_up/index.html')
-rw-r--r-- | docs/en/gun/1.0/manual/gun.await_up/index.html | 123 |
1 files changed, 35 insertions, 88 deletions
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> + |