From 74a12ffc8b37f2dae4b3002e86f33b8ca52df22d Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 29 Dec 2019 23:21:33 -0800 Subject: man page updates for 1.2 --- man/v1.2/nng_sockaddr.5.html | 654 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 654 insertions(+) create mode 100644 man/v1.2/nng_sockaddr.5.html (limited to 'man/v1.2/nng_sockaddr.5.html') diff --git a/man/v1.2/nng_sockaddr.5.html b/man/v1.2/nng_sockaddr.5.html new file mode 100644 index 00000000..98413d8c --- /dev/null +++ b/man/v1.2/nng_sockaddr.5.html @@ -0,0 +1,654 @@ +--- +version: 1.2 +layout: refman +--- + + + + + + + +nng_sockaddr(5) + + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef union nng_sockaddr {
+    uint16_t            s_family;
+    nng_sockaddr_ipc    s_ipc;
+    nng_sockaddr_inproc s_inproc;
+    nng_sockaddr_in     s_in;
+    nng_sockaddr_in6    s_in6;
+    nng_sockaddr_zt     s_zt;
+} nng_sockaddr;
+
+enum sockaddr_family {
+    NNG_AF_UNSPEC = 0,
+    NNG_AF_INPROC = 1,
+    NNG_AF_IPC    = 2,
+    NNG_AF_INET   = 3,
+    NNG_AF_INET6  = 4,
+    NNG_AF_ZT     = 5,
+};
+
+
+
+
+
+

DESCRIPTION

+
+
+

+An nng_sockaddr is a structure used for +representing the addresses used by underlying transports, such as TCP/IP +addresses, IPC paths, and so forth.

+
+
+
+
+

The name sockaddr is based on its similarity with POSIX struct sockaddr, +but in the nng library, these addresses are more closely affiliated with +instances of nng_pipe +than of nng_socket. +The naming confusion is unfortunate.

+
+
+
+
+

This structure is actually a union, with different members for different +types of addresses.

+
+
+

Every member structure has as its first element a uint16_t field +containing the “address family”. +This overlaps the s_family member of the union, and indicates which +specific member should be used.

+
+
+

The values of s_family are as follows:

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+NNG_AF_UNSPEC + +

Invalid address, no other valid fields.

+
+NNG_AF_INPROC + +

Address for intraprocess communication (nng_inproc(7)). The s_inproc member is valid.

+
+NNG_AF_IPC + +

Address for interprocess communication (nng_ipc(7)). The s_path member is valid.

+
+NNG_AF_INET + +

Address for TCP/IP (v4) communication. The s_in member is valid.

+
+NNG_AF_INET6 + +

Address for TCP/IP (v6) communication. The s_in6 member is valid.

+
+NNG_AF_ZT + +

Address for ZeroTier transport (nng_zerotier(7)). The s_zt member is valid.

+
+
+
+

Please see the manual pages for each individual type for more information.

+
+
+
+
+

SEE ALSO

+
+
+

nng_sockaddr_in(5), +nng_sockaddr_in6(5), +nng_sockaddr_inproc(5), +nng_sockaddr_ipc(5), +nng_sockaddr_zt(5), +nng(7)

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