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