summaryrefslogtreecommitdiff
path: root/docs/reference/src/sock/nng_pair_open.md
blob: fe955df52eb8a961a02dd10249dfd4814742d8cc (plain)
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
# nng_pair_open

## NAME

nng_pair_open --- create _PAIR_ socket

## SYNOPSIS

#### Version 0
```c
#include <nng/protocol/pair0/pair.h>

int nng_pair0_open(nng_socket *s);

int nng_pair0_open_raw(nng_socket *s);
```

#### Version 1
```c
#include <nng/protocol/pair1/pair.h>

int nng_pair1_open(nng_socket *s);

int nng_pair1_open_raw(nng_socket *s);

int nng_pair1_open_poly(nng_socktet *s);
```

## DESCRIPTION

The `nng_pair0_open()` and `nng_pair1_open()` functions
create a [{{i:*PAIR*}}][pair] version 0 or version 1
[socket][socket] and return it at the location pointed to by _s_.

The `nng_pair0_open_raw()` and `nng_pair1_open_raw()` functions
create a _PAIR_ version 0 or version 1 socket in
[raw mode][raw] and return it at the location pointed to by _s_.

The `nng_pair1_open_poly()` function opens a pair version 1 socket in
{{i:polyamorous mode}}.

> [!NOTE]
> Polyamorous mode is deprecated and should not be used in new applications.
> The `nng_pair1_open_poly()` function will likely be removed in a future release.

## RETURN VALUES

These functions returns 0 on success, and non-zero otherwise.

## ERRORS

* `NNG_ENOMEM`:: Insufficient memory is available.
* `NNG_ENOTSUP`:: The protocol is not supported.

## SEE ALSO

[Sockets][socket],
[_PAIR_ Protocol][pair]

{{#include ../refs.md}}