From ff237834c56b370c6d2247a767f3886d9eb4e94c Mon Sep 17 00:00:00 2001 From: "Staysail Systems, Inc" Date: Mon, 1 Jan 2024 17:24:25 -0800 Subject: Manual page updates for v1.7.0 --- man/v1.7.0/nng_socket_pair.3supp.html | 108 ++++++++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 man/v1.7.0/nng_socket_pair.3supp.html (limited to 'man/v1.7.0/nng_socket_pair.3supp.html') diff --git a/man/v1.7.0/nng_socket_pair.3supp.html b/man/v1.7.0/nng_socket_pair.3supp.html new file mode 100644 index 00000000..aabcc0a4 --- /dev/null +++ b/man/v1.7.0/nng_socket_pair.3supp.html @@ -0,0 +1,108 @@ +--- +version: v1.7.0 +layout: manpage_v2 +title: nng_socket_pair(3supp) +--- +

nng_socket_pair(3supp)

+
+

NAME

+
+
+

nng_socket_pair - create a connected pair of BSD sockets

+
+
+
+
+

SYNOPSIS

+
+
+
+
#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 socket transport.

+
+
+

On POSIX platforms, this is a thin wrapper around the standard socketpair() function, +using the AF_UNIX family and the SOCK_STREAM socket type.

+
+
+ + + + + +
+ + +At present only POSIX platforms implementing socketpair() are supported with this function. +
+
+
+ + + + + +
+ + +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

+
+
+

nng_socket(7), +nng(7)

+
+
+
-- cgit v1.2.3-70-g09d2