man/tip/nng_dialer_id.3.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

---
version: tip
layout: manpage_v2
title: nng_dialer_id(3)
---
<h1>nng_dialer_id(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_dialer_id - return numeric dialer identifier</p>
</div>
</div>
</div>
<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-w"> </span><span class="tok-cpf">&lt;nng/nng.h&gt;</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_dialer_id</span><span class="tok-p">(</span><span class="tok-n">nng_dialer</span><span class="tok-w"> </span><span class="tok-n">d</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>The <code>nng_dialer_id()</code> function returns a positive identifier for the dialer <em>d</em>,
if it is valid.
Otherwise it returns <code>-1</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
A dialer is considered valid if it was ever created with 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.
Dialers that are allocated on the stack or statically should be
initialized with the macro
<a href="nng_ctx.5.html#NNG_DIALER_INITIALIZER"><code>NNG_DIALER_INITIALIZER</code></a> to ensure that
they cannot be confused with a valid dialer before they are created properly.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This function returns the positive value for the dialer identifier, or
<code>-1</code> if the dialer is invalid.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</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_dialer.5.html">nng_dialer(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>