man/tip/nng_pair_open.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
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

---
version: tip
layout: manpage_v2
title: nng_pair_open(3)
---
<h1>nng_pair_open(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_pair_open - create pair socket</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="title">Version 0</div>
<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/protocol/pair0/pair.h&gt;</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_pair0_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_pair0_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span></code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Version 1</div>
<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/protocol/pair1/pair.h&gt;</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_pair1_open</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_pair1_open_raw</span><span class="tok-p">(</span><span class="tok-n">nng_socket</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</span><span class="tok-p">);</span>

<span class="tok-kt">int</span><span class="tok-w"> </span><span class="tok-nf">nng_pair1_open_poly</span><span class="tok-p">(</span><span class="tok-n">nng_socktet</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">s</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_pair0_open()</code> and <code>nng_pair1_open()</code> functions
create a <a href="nng_pair.7.html"><em>pair</em></a> version 0 or version 1
<a href="nng_socket.5.html">socket</a> and return it at the location pointed to by <em>s</em>.</p>
</div>
<div class="paragraph">
<p>The <code>nng_pair0_open_raw()</code> and <code>nng_pair1_open_raw()</code> functions
create a <a href="nng_pair.7.html"><em>pair</em></a> version 0 or version 1
<a href="nng_socket.5.html">socket</a> in
<a href="nng.7.html#raw_mode">raw</a> mode and return it at the location pointed to by <em>s</em>.</p>
</div>
<div class="paragraph">
<p>The <code>nng_pair1_open_poly()</code> function opens a pair version 1 socket in
polyamorous mode.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Polyamorous mode is deprecated and should not be used in new applications.
The <code>nng_pair1_open_poly()</code> function will likely be removed in a future release.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>These functions 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_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient memory is available.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_ENOTSUP</code>
</td>
<td class="hdlist2">
<p>The protocol is not supported.</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_socket.5.html">nng_socket(5)</a>,
<a href="nng_pair.7.html">nng_pair(7)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>