aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-10-26 10:54:58 -0700
committerGarrett D'Amore <garrett@damore.org>2025-10-27 07:13:40 -0700
commitbe13c2e8845423cec17af429fc4e16a5d9749e47 (patch)
tree82614e403a41aac6581a9a223ef9eba5be557222 /docs/man
parent11c53f3d7f747d14fd69ce98c63d629bc821ef68 (diff)
downloadnng-be13c2e8845423cec17af429fc4e16a5d9749e47.tar.gz
nng-be13c2e8845423cec17af429fc4e16a5d9749e47.tar.bz2
nng-be13c2e8845423cec17af429fc4e16a5d9749e47.zip
Replace nng_pipe_get_addr, nng_stream_get_addr, and the NNG_OPT_REMADDR option.
More direct access methods are provided instead. This results in much lower friction when using, and is a step on the path to removing NNG_OPT_LOCADDR as well. We need to figure a solution for NNG_OPT_LOCADDR for dialers; for listeners there is little use in it either, and it will be removed. (Dialers will probably get a new NNG_OPT_BIND_IP option.)
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_listener_get.3.adoc6
-rw-r--r--docs/man/nng_options.5.adoc10
-rw-r--r--docs/man/nng_tcp.7.adoc1
-rw-r--r--docs/man/nng_tcp_options.5.adoc1
-rw-r--r--docs/man/nng_tls.7.adoc1
-rw-r--r--docs/man/nng_tls_options.5.adoc1
6 files changed, 1 insertions, 19 deletions
diff --git a/docs/man/nng_listener_get.3.adoc b/docs/man/nng_listener_get.3.adoc
index 4c4de6b4..c8ffc185 100644
--- a/docs/man/nng_listener_get.3.adoc
+++ b/docs/man/nng_listener_get.3.adoc
@@ -27,8 +27,6 @@ int nng_listener_get_ms(nng_listener l, const char *opt, nng_duration *durp);
int nng_listener_get_size(nng_listener l, const char *opt, size_t *zp);
-int nng_listener_get_addr(nng_listener l, const char *opt, nng_sockaddr *sap);
-
int nng_listener_get_string(nng_listener l, const char *opt, const char **strp);
int nng_listener_get_uint64(nng_listener l, const char *opt, uint64_t *u64p);
@@ -69,10 +67,6 @@ This function is used to retrieve time xref:nng_duration.5.adoc[durations]
This function is used to retrieve a size into the pointer _zp_,
typically for buffer sizes, message maximum sizes, and similar options.
-`nng_listener_get_addr()`::
-This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`]
-into the value referenced by _sap_.
-
`nng_listener_get_string()`::
This function is used to retrieve a string into _strp_.
diff --git a/docs/man/nng_options.5.adoc b/docs/man/nng_options.5.adoc
index 3e67ba9c..0a9a67ad 100644
--- a/docs/man/nng_options.5.adoc
+++ b/docs/man/nng_options.5.adoc
@@ -25,7 +25,6 @@ nng_options - socket, dialer, listener, and pipe options
#define NNG_OPT_RECVTIMEO "recv-timeout"
#define NNG_OPT_SENDTIMEO "send-timeout"
#define NNG_OPT_LOCADDR "local-address"
-#define NNG_OPT_REMADDR "remote-address"
#define NNG_OPT_URL "url"
#define NNG_OPT_MAXTTL "ttl-max"
#define NNG_OPT_RECVMAXSZ "recv-size-max"
@@ -75,7 +74,7 @@ description of the option.
[[NNG_OPT_LOCADDR]]
((`NNG_OPT_LOCADDR`))::
(xref:nng_sockaddr.5.adoc[`nng_sockaddr`])
-This read-only option may be used on listeners, dialers and connected pipes, and
+This read-only option may be used dialers and
represents the local address used for communication.
NOTE: Not all transports support this option, and some transports may support it on
listeners but not dialers.
@@ -153,13 +152,6 @@ are established.)
NOTE: Some transports may have further message size restrictions.
-[[NNG_OPT_REMADDR]]
-((`NNG_OPT_REMADDR`))::
-(xref:nng_sockaddr.5.adoc[`nng_sockaddr`])
-This read-only option may be used on dialers and connected pipes, and
-represents the address of a remote peer.
-Not all transports support this option.
-
[[NNG_OPT_MAXTTL]]
((`NNG_OPT_MAXTTL`))::
(`int`)
diff --git a/docs/man/nng_tcp.7.adoc b/docs/man/nng_tcp.7.adoc
index cf84ac7e..b68b9286 100644
--- a/docs/man/nng_tcp.7.adoc
+++ b/docs/man/nng_tcp.7.adoc
@@ -77,7 +77,6 @@ The following transport options are supported by this transport,
where supported by the underlying platform.
* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`]
-* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`]
* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`]
* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NODELAY[`NNG_OPT_TCP_NODELAY`]
* xref:nng_options.5.adoc#NNG_OPT_URL[`NNG_OPT_URL`]
diff --git a/docs/man/nng_tcp_options.5.adoc b/docs/man/nng_tcp_options.5.adoc
index c6063d8a..ed1bf4a7 100644
--- a/docs/man/nng_tcp_options.5.adoc
+++ b/docs/man/nng_tcp_options.5.adoc
@@ -117,7 +117,6 @@ Generally, the following option values are also available for TCP objects,
when appropriate for the context:
* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`]
-* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`]
== SEE ALSO
diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc
index 1430e537..4a50bf1f 100644
--- a/docs/man/nng_tls.7.adoc
+++ b/docs/man/nng_tls.7.adoc
@@ -102,7 +102,6 @@ The following transport options are available.
Note that setting these must be done before the transport is started.
* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`]
-* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`]
* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`]
* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NODELAY[`NNG_OPT_TCP_NODELAY`]
* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_VERIFIED[`NNG_OPT_TLS_VERIFIED_`]
diff --git a/docs/man/nng_tls_options.5.adoc b/docs/man/nng_tls_options.5.adoc
index f7cce90a..fb88784b 100644
--- a/docs/man/nng_tls_options.5.adoc
+++ b/docs/man/nng_tls_options.5.adoc
@@ -71,7 +71,6 @@ Generally, the following option values are also available for TLS objects,
when appropriate for the context:
* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`]
-* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`]
* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`]
* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NODELAY[`NNG_OPT_TCP_NODELAY`]