aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2020-10-29 23:07:23 -0700
committerGarrett D'Amore <garrett@damore.org>2020-10-29 23:07:23 -0700
commit6b147e879431d615bebb867263a776ac20e1864d (patch)
tree388086abb265efe0ac7b96489181e5ff9c396752 /docs
parent5b529c298eb8b56eb2df5a86d9274de06d9ce796 (diff)
downloadnng-6b147e879431d615bebb867263a776ac20e1864d.tar.gz
nng-6b147e879431d615bebb867263a776ac20e1864d.tar.bz2
nng-6b147e879431d615bebb867263a776ac20e1864d.zip
fixes #1022 Support tcp6 link local addresses
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_sockaddr_in6.5.adoc8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/man/nng_sockaddr_in6.5.adoc b/docs/man/nng_sockaddr_in6.5.adoc
index 804056c5..8515ed25 100644
--- a/docs/man/nng_sockaddr_in6.5.adoc
+++ b/docs/man/nng_sockaddr_in6.5.adoc
@@ -27,6 +27,7 @@ typedef struct {
uint16_t sa_family;
uint16_t sa_port;
uint8_t sa_addr[16];
+ uint32_t sa_scope;
} nng_sockaddr_in6;
----
@@ -54,6 +55,13 @@ The following structure members are present:
This field holds the ((IP address))(((address, IPv6))) in
network-byte order.
+`sa_scope`::
+ This is the scope, and is typically used with link local
+ addresses to identify a specific interface. The details of
+ this are specific to the operating system. This value is
+ presented identically to the underlying system's, including
+ any byte order considerations.
+
TIP: The `sa_port` and `sa_addr` fields are in network-byte order to
facilitate their use with system APIs such as `inet_ntop()`.
Most platforms use some form of BSD-derived network API, which uses