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
|
---
version: v1.3.2
layout: manpage_v2
---
<h1>nng_stream_dialer_alloc(3str)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_stream_dialer_alloc - allocate byte stream 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 class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span><span class="tok-cp">
</span><span class="tok-cp"></span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">**</span><span class="tok-n">dp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">addr</span><span class="tok-p">);</span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_stream_dialer_alloc_url</span><span class="tok-p">(</span><span class="tok-n">nng_stream_dialer</span> <span class="tok-o">**</span><span class="tok-n">dp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-n">nng_url</span> <span class="tok-o">*</span><span class="tok-n">url</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>These functions allocates a dialer for byte streams.
Dialers create
<a href="nng_stream.5.html"><code>nng_stream</code></a> objects by initiating outgoing
connections, via the
<a href="nng_stream_dialer_dial.3str.html"><code>nng_stream_dialer_dial()</code></a> function.</p>
</div>
<div class="paragraph">
<p>The first form, <code>nng_stream_dialer_alloc()</code>, connects to the address
specified by <em>addr</em>, which should be a string representing a URL.</p>
</div>
<div class="paragraph">
<p>The second form, <code>nng_stream_dialer_alloc_url()</code>, takes a pre-parsed
or pre-constructed
<a href="nng_url.5.html"><code>nng_url</code></a> object to determine the remote address.</p>
</div>
<div class="paragraph">
<p>These functions may support different URL schemes, such as
<code>ipc://</code>, <code>tcp://</code>, <code>tls+tcp://</code>, or <code>ws://</code>.</p>
</div>
<div class="paragraph">
<p>Both forms store the dialer in the location referenced by <em>dp</em>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>These functions return 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_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory exists.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>The URL scheme is not supported by the implementation.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EADDRINVAL</code>
</td>
<td class="hdlist2">
<p>The URL requested is invalid.</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_strerror.3.html">nng_strerror(3)</a>,
<a href="nng_stream_dialer_close.3str.html">nng_stream_dialer_close(3str)</a>
<a href="nng_stream_dialer_dial.3str.html">nng_stream_dialer_dial(3str)</a>
<a href="nng_stream_dialer_free.3str.html">nng_stream_dialer_free(3str)</a>
<a href="nng_stream_dialer_get.3str.html">nng_stream_dialer_get(3str)</a>
<a href="nng_stream_dialer_set.3str.html">nng_stream_dialer_set(3str)</a>
<a href="nng_stream_dialer.5.html">nng_stream_dialer(5)</a></p>
</div>
</div>
</div>
|
