diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-01-23 23:24:04 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-01-23 23:24:04 -0800 |
| commit | 8b8fdbdc2e3fef03e21177eb3710491e4c080d43 (patch) | |
| tree | 0336322fa94119e9e37f9d88545ba6e58307cf2a /man/v1.2.4/nng_dialer.5.html | |
| parent | b67502ab569fafc050cb9b0380d2886bc2068ece (diff) | |
| download | nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.gz nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.tar.bz2 nng-8b8fdbdc2e3fef03e21177eb3710491e4c080d43.zip | |
Publishing updates for v1.2.4
Diffstat (limited to 'man/v1.2.4/nng_dialer.5.html')
| -rw-r--r-- | man/v1.2.4/nng_dialer.5.html | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/man/v1.2.4/nng_dialer.5.html b/man/v1.2.4/nng_dialer.5.html new file mode 100644 index 00000000..5c79756b --- /dev/null +++ b/man/v1.2.4/nng_dialer.5.html @@ -0,0 +1,151 @@ +--- +version: v1.2.4 +layout: refman +--- +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 2.0.10"> +<title>nng_dialer(5)</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> +<link rel="stylesheet" href="./asciidoctor.css"> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> +</head> +<body class="manpage toc2 toc-left"> +<div id="header"> +<h1>nng_dialer(5) Manual Page</h1> +<div id="toc" class="toc2"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_synopsis">SYNOPSIS</a></li> +<li><a href="#_description">DESCRIPTION</a> +<ul class="sectlevel2"> +<li><a href="#NNG_DIALER_INITIALIZER">Initialization</a></li> +</ul> +</li> +<li><a href="#_see_also">SEE ALSO</a></li> +</ul> +</div> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<p>nng_dialer - dialer</p> +</div> +</div> +<div id="content"> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span><span class="tok-cp"></span> + +<span class="tok-k">typedef</span> <span class="tok-k">struct</span> <span class="tok-n">nng_dialer_s</span> <span class="tok-n">nng_dialer</span><span class="tok-p">;</span></code></pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p> +An <code>nng_dialer</code> is a handle to a “dialer” object, which is responsible for +creating a single <a href="nng_pipe.5.html"><code>nng_pipe</code></a> at a time by +establishing an outgoing connection.</p> +</div> +<div class="paragraph"> +<p>If the connection is broken, or fails, the dialer object will automatically +attempt to reconnect, and will keep doing so until the dialer or socket is +destroyed.</p> +</div> +<div class="paragraph"> +<p>Dialer objects are created by the +<a href="nng_dialer_create.3.html"><code>nng_dialer_create()</code></a> +or <a href="nng_dial.3.html"><code>nng_dial()</code></a> functions, and are always “owned” +by a single <a href="nng_socket.5.html"><code>nng_socket</code></a>.</p> +</div> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-important" title="Important"></i> +</td> +<td class="content"> +The <code>nng_dialer</code> structure is always passed by value (both +for input parameters and return values), and should be treated opaquely. +Passing structures this way gives the compiler a chance to perform +accurate type checks in functions passing values of this type. +</td> +</tr> +</table> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +A given <a href="nng_socket.5.html"><code>nng_socket</code></a> may have multiple dialer +objects, multiple <a href="nng_listener.5.html">listener</a> objects, or even some +of both. +</td> +</tr> +</table> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +The client/server relationship described by dialer/listener is +completely orthogonal to any similar relationship in the protocols. +For example, a <a href="nng_rep.7.html"><em>rep</em></a> socket may use a dialer +to connect to a listener on an <a href="nng_req.7.html"><em>req</em></a> socket. +This orthogonality can lead to innovative solutions to otherwise +challenging communications problems. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>Dialer objects may be destroyed by the +<a href="nng_dialer_close.3.html"><code>nng_dialer_close()</code></a> function. +They are also closed when their “owning” socket is closed.</p> +</div> +<div class="sect2"> +<h3 id="NNG_DIALER_INITIALIZER">Initialization</h3> +<div class="paragraph"> +<p>A dialer may be initialized using the macro <code>NNG_DIALER_INITIALIZER</code> +before it is opened, to prevent confusion with valid open dialers.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph text-left"> +<p><a href="nng_dial.3.html">nng_dial(3)</a>, +<a href="nng_dialer_close.3.html">nng_dialer_close(3)</a>, +<a href="nng_dialer_create.3.html">nng_dialer_create(3)</a>, +<a href="nng_dialer_getopt.3.html">nng_dialer_getopt(3)</a>, +<a href="nng_dialer_id.3.html">nng_dialer_id(3)</a>, +<a href="nng_dialer_setopt.3.html">nng_dialer_setopt(3)</a>, +<a href="nng_dialer_start.3.html">nng_dialer_start(3)</a>, +<a href="nng_listener.5.html">nng_listener(5)</a>, +<a href="nng_pipe.5.html">nng_pipe(5)</a>, +<a href="nng_socket.5.html">nng_socket(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> +</div> +<link rel="stylesheet" href="./pygments-default.css"> +</body> +</html>
\ No newline at end of file |