From e4e646a6a9982ff932d83633157106a0b34975a2 Mon Sep 17 00:00:00 2001 From: "Staysail Systems, Inc" Date: Fri, 1 Mar 2024 07:04:14 -0800 Subject: Manual page updates for v1.7.3 --- man/v1.7.3/nng_socket.7.html | 129 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 man/v1.7.3/nng_socket.7.html (limited to 'man/v1.7.3/nng_socket.7.html') diff --git a/man/v1.7.3/nng_socket.7.html b/man/v1.7.3/nng_socket.7.html new file mode 100644 index 00000000..64f3386f --- /dev/null +++ b/man/v1.7.3/nng_socket.7.html @@ -0,0 +1,129 @@ +--- +version: v1.7.3 +layout: manpage_v2 +title: nng_socket(7) +--- +

nng_socket(7)

+
+

NAME

+
+
+

nng_socket - BSD Socket transport (experimental)

+
+
+
+
+

DESCRIPTION

+
+
+

+The socket transport supports communication between +peers across arbitrary BSD sockets, such as those that are +created with nng_socket_pair().

+
+
+

This transport only supports listeners, using nng_listener_create().

+
+
+ + + + + +
+ + +Attempts to create dialers using this transport will result in NNG_ENOTSUP. +
+
+
+

The socket file descriptor is passed to the listener using the NNG_OPT_SOCKET_FD option (as an integer). +Setting this option will cause the listener to create a pipe associated backed by the file descriptor.

+
+
+

The protocol between peers using this transport is compatible with the protocol used for the +TCP transport, but this is an implementation detail and subject to change without notice.

+
+
+ + + + + +
+ + +This transport is experimental, and at present is only supported on POSIX platforms. +
+
+
+

Registration

+
+

No special action is necessary to register this transport.

+
+
+
+

URI Format

+
+

+This transport uses the URL socket://, without further qualification.

+
+
+
+

Socket Address

+
+

The socket address will be of family NNG_AF_UNSPEC. +There are no further socket details available.

+
+
+
+

Transport Options

+
+

The following transport option is available:

+
+
+
+
NNG_OPT_SOCKET_FD
+
+

(int) This is a write-only option, that may be set multiple times on a listener. +Each time this is set, the listener will create a pipe backed by the given file +descriptor passed as an argument.

+
+
+
+
+

Additionally, the following options may be supported on pipes when the platform supports them:

+
+
+ +
+
+
+
+
+

SEE ALSO

+
+
+

nng_socket_pair(3), +nng_dialer(5), +nng_listener(5), +nng_options(5), +nng_pipe(5), +nng_sockaddr(5), +nng(7)

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