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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
---
version: tip
layout: manpage_v2
title: nng_dialer_start(3)
---
<h1>nng_dialer_start(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_dialer_start - start dialer</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"><nng/nng.h></span>
<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_dialer_start</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><span class="tok-w"> </span><span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-n">flags</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_start()</code> function starts the dialer <em>d</em>.</p>
</div>
<div class="paragraph">
<p>This causes the dialer to start connecting to the address with which it was
created.</p>
</div>
<div class="paragraph">
<p>When a connection is established, it results in a pipe being created,
which will be attached to the dialer’s socket.</p>
</div>
<div class="paragraph">
<p>Normally, the first attempt to connect to the dialer’s address is done
synchronously, including any necessary name resolution.
As a result, a failure, such as if the connection is refused, will be returned
immediately, and no further action will be taken.</p>
</div>
<div class="paragraph">
<p>However, if the special value <code>NNG_FLAG_NONBLOCK</code> is
supplied in <em>flags</em>, then the connection attempt is made asynchronously.</p>
</div>
<div class="paragraph">
<p>Furthermore, if the connection was closed for a synchronously dialed
connection, the dialer will still attempt to redial asynchronously.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
While <code>NNG_FLAG_NONBLOCK</code> can help an application be more resilient,
it also generally makes diagnosing failures somewhat more difficult.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Once a dialer has started, it is generally not possible to change
its configuration.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This function returns 0 on success, and non-zero otherwise.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
<code>NNG_EADDRINVAL</code>
</td>
<td class="hdlist2">
<p>An invalid <em>url</em> was specified.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECLOSED</code>
</td>
<td class="hdlist2">
<p>The socket <em>s</em> is not open.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECONNREFUSED</code>
</td>
<td class="hdlist2">
<p>The remote peer refused the connection.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ECONNRESET</code>
</td>
<td class="hdlist2">
<p>The remote peer reset the connection.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EINVAL</code>
</td>
<td class="hdlist2">
<p>An invalid set of <em>flags</em> was specified.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient memory is available.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EPEERAUTH</code>
</td>
<td class="hdlist2">
<p>Authentication or authorization failure.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EPROTO</code>
</td>
<td class="hdlist2">
<p>A protocol error occurred.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ESTATE</code>
</td>
<td class="hdlist2">
<p>The dialer <em>d</em> is already started.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EUNREACHABLE</code>
</td>
<td class="hdlist2">
<p>The remote address is not reachable.</p>
</td>
</tr>
</table>
</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_create.3.html">nng_dialer_create(3)</a>
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_dialer.5.html">nng_dialer(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
|
