aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-10-26 10:02:33 -0700
committerGarrett D'Amore <garrett@damore.org>2025-10-26 10:02:33 -0700
commit72b96ad6925634e1b4efa775ffbed436b0a29abd (patch)
treeaca1508cbc9fa89597fae7e059263725983d6485 /docs/man
parente0cb4377cc4d6fe50514e0b297e174fdde001bb6 (diff)
downloadnng-72b96ad6925634e1b4efa775ffbed436b0a29abd.tar.gz
nng-72b96ad6925634e1b4efa775ffbed436b0a29abd.tar.bz2
nng-72b96ad6925634e1b4efa775ffbed436b0a29abd.zip
NNG_OPT_BOUND_PORT replaces NNG_OPT_TCP/UDP_BOUND_PORT.
This is easier and agnostic about the underlying L3 protocol. We plan to remove direct NNG_OPT_LOCADDR support from listeners (and probably both NNG_OPT_LOCADDR and NNG_OPT_REMADDR have numbered days left in their lifetime. They will be replaced with more direct typed access functions as has been done for pipes already.) While here fixed some include for IWYU in the POSIX platform.
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_tcp_options.5.adoc8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/man/nng_tcp_options.5.adoc b/docs/man/nng_tcp_options.5.adoc
index 37228b82..c6063d8a 100644
--- a/docs/man/nng_tcp_options.5.adoc
+++ b/docs/man/nng_tcp_options.5.adoc
@@ -22,7 +22,7 @@ nng_tcp_options - TCP-specific options
#define NNG_OPT_TCP_NODELAY "tcp-nodelay"
#define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive"
-#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port"
+#define NNG_OPT_BOUND_PORT "bound-port"
----
== DESCRIPTION
@@ -89,10 +89,10 @@ First, it can be used to detect dead peers on an otherwise quiescent network.
Second, it can be used to keep connection table entries in NAT and other
middleware from being expiring due to lack of activity.
-[[NNG_OPT_TCP_BOUND_PORT]]
-((`NNG_OPT_TCP_BOUND_PORT`))::
+[[NNG_OPT_BOUND_PORT]]
+((`NNG_OPT_BOUND_PORT`))::
(`int`)
-This option is available on listeners, after the listern has bound to
+This option is available on listeners, after the listener has bound to
a port, and provides the port bound to in native byte order.
This is most useful when using a listener with an ephemeral port
(configured by using port 0 at configuration time), as it allows