diff options
Diffstat (limited to 'docs/en/gun/1.2/manual/gun.open/index.html')
| -rw-r--r-- | docs/en/gun/1.2/manual/gun.open/index.html | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/docs/en/gun/1.2/manual/gun.open/index.html b/docs/en/gun/1.2/manual/gun.open/index.html new file mode 100644 index 00000000..f8bf4d98 --- /dev/null +++ b/docs/en/gun/1.2/manual/gun.open/index.html @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: gun:open(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=2" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + +</head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>gun:open(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>gun:open - Open a connection to the given host and port</p> +<h2 id="_description">Description</h2> +<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><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> +<dl><dt>Host</dt> +<dd><p>Host or IP address to connect to.</p> +</dd> +<dt>Port</dt> +<dd><p>Port to connect to.</p> +</dd> +<dt>Opts</dt> +<dd><p>Options for this connection.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<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> +<ul><li><strong>1.0</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<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>{<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>{<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>{<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> +<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 class="span3 sidecol"> + + +<h3> + Gun + 1.2 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/gun/1.2/guide">User Guide</a></li> + + + <li><a href="/docs/en/gun/1.2/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/gun/1.2/manual">1.2</a></li> + + <li><a href="/docs/en/gun/1.1/manual">1.1</a></li> + + <li><a href="/docs/en/gun/1.0/manual">1.0</a></li> + +</ul> + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + |