blob: ac0fb76af3c9463a4cb5a62b44367f7b5445e1f6 (
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
|
# nng_socket_pair
## NAME
nng_socket_pair --- create a connected pair of BSD sockets
## SYNOPSIS
```c
#include <nng/nng.h>
#include <nng/supplemental/util/platform.h>
int nng_socket_pair(int fds[2]);
```
## DESCRIPTION
The `nng_socket_pair()` function creates a pair of connected BSD sockets.
These sockets, which are returned in the _fds_ array, are suitable for
use with the [BSD Socket][sockfd] transport.
On POSIX platforms, this is a thin wrapper around the standard `socketpair()` function,
using the {{i:`AF_UNIX`}} family and the `SOCK_STREAM` socket type.[^1]
[^1]: At present only POSIX platforms implementing `socketpair()` support this function.
> [!TIP]
> This function may be useful for creating a shared connection between a parent process and
> a child process on UNIX platforms, without requiring the processes use a shared filesystem or TCP connection.
## RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
## ERRORS
- `NNG_ENOMEM`: Insufficient memory exists.
- `NNG_ENOTSUP`: This platform does not support socket pairs.
## SEE ALSO
[BSD Socket Transport][sockfd]
{{#include ../refs.md}}
|
