From edd3b6bc34f211bd3d58642d0c69ce1b5bb9dc3b Mon Sep 17 00:00:00 2001 From: gdamore Date: Thu, 9 Oct 2025 01:22:20 +0000 Subject: deploy: 9c834956456924df7c885ab8b79573721acaff5c --- ref/tran/socket.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'ref/tran/socket.html') diff --git a/ref/tran/socket.html b/ref/tran/socket.html index f7b4c823..d19de445 100644 --- a/ref/tran/socket.html +++ b/ref/tran/socket.html @@ -247,21 +247,21 @@

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.

+created with nng_socket_pair.

+

This transport only supports listeners, using nng_listener_create.

note

-

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

+

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 +Setting this option will cause the listener to create a pipe 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. +for the tcp transport, but this is an implementation detail and subject to change without notice. 1

@@ -279,7 +279,7 @@ There are no further socket details available.

Transport Options

The following transport options are supported by this transport.

- + @@ -291,7 +291,7 @@ There are no further socket details available.

note

The NNG_OPT_PEER_GID, NNG_OPT_PEER_PID, NNG_OPT_PEER_UID, and NNG_OPT_PEER_ZONEID options depend on platform support. -These behave in exactly the same fashion as for the ipc transport.

+These behave in exactly the same fashion as for the ipc transport.


-

1: Specifically it is not compatible with the ipc transport.

+

1: Specifically it is not compatible with the ipc transport.

2: Windows lacks a suitable socketpair equivalent function we could use.

-- cgit v1.2.3-70-g09d2
OptionTypeDescription
NNG_OPT_SOCKET_FDintWrite-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.
NNG_OPT_SOCKET_FDintWrite-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.
NNG_OPT_PEER_GIDintRead only option, returns the group ID of the process at the other end of the socket, if platform supports it.
NNG_OPT_PEER_PIDintRead only option, returns the processed ID of the process at the other end of the socket, if platform supports it.
NNG_OPT_PEER_UIDintRead only option, returns the user ID of the process at the other end of the socket, if platform supports it.