aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/xref.md
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/ref/xref.md
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/ref/xref.md')
-rw-r--r--docs/ref/xref.md6
1 files changed, 2 insertions, 4 deletions
diff --git a/docs/ref/xref.md b/docs/ref/xref.md
index d64840cb..80a3d1b7 100644
--- a/docs/ref/xref.md
+++ b/docs/ref/xref.md
@@ -125,7 +125,6 @@
[`nng_stream_get_int`]: ../api/stream.md#getting-stream-options
[`nng_stream_get_ms`]: ../api/stream.md#getting-stream-options
[`nng_stream_get_size`]: ../api/stream.md#getting-stream-options
-[`nng_stream_get_addr`]: ../api/stream.md#getting-stream-options
[`nng_stream_get_string`]: ../api/stream.md#getting-stream-options
[`nng_stream_dialer`]: ../api/stream.md#stream-factories
[`nng_stream_listener`]: ../api/stream.md#stream-factories
@@ -162,7 +161,6 @@
[`nng_stream_listener_get_int`]: ../api/stream.md#stream-factory-options
[`nng_stream_listener_get_ms`]: ../api/stream.md#stream-factory-options
[`nng_stream_listener_get_size`]: ../api/stream.md#stream-factory-options
-[`nng_stream_listener_get_addr`]: ../api/stream.md#stream-factory-options
[`nng_stream_listener_get_string`]: ../api/stream.md#stream-factory-options
[`nng_stream_listener_set_bool`]: ../api/stream.md#stream-factory-options
[`nng_stream_listener_set_int`]: ../api/stream.md#stream-factory-options
@@ -257,9 +255,10 @@
[`nng_pipe_get_int`]: ../api/pipe.md#pipe-options
[`nng_pipe_get_ms`]: ../api/pipe.md#pipe-options
[`nng_pipe_get_size`]: ../api/pipe.md#pipe-options
-[`nng_pipe_get_addr`]: ../api/pipe.md#pipe-options
[`nng_pipe_get_string`]: ../api/pipe.md#pipe-options
[`nng_pipe_notify`]: ../api/pipe.md#pipe-notifications
+[`nng_pipe_peer_addr`]: ../api/pipe.md#pipe-socket-addresses
+[`nng_pipe_self_addr`]: ../api/pipe.md#pipe-socket-addresses
[`nng_sockaddr`]: ../TODO.md
[`nng_sockaddr_in`]: ../TODO.md
[`nng_sockaddr_in6`]: ../TODO.md
@@ -451,7 +450,6 @@
[`NNG_OPT_RECVBUF`]: ../api/sock.md#NNG_OPT_RECVBUF
[`NNG_OPT_RECVMAXSZ`]: ../api/sock.md#NNG_OPT_RECVMAXSZ
[`NNG_OPT_LOCADDR`]: ../api/sock.md#NNG_OPT_LOCADDR
-[`NNG_OPT_REMADDR`]: ../api/sock.md#NNG_OPT_REMADDR
[`NNG_OPT_PEER_UID`]: ../tran/ipc.md#NNG_OPT_PEER_UID
[`NNG_OPT_PEER_GID`]: ../tran/ipc.md#NNG_OPT_PEER_GID
[`NNG_OPT_PEER_PID`]: ../tran/ipc.md#NNG_OPT_PEER_PID