aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/stream.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/api/stream.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/api/stream.md')
-rw-r--r--docs/ref/api/stream.md5
1 files changed, 0 insertions, 5 deletions
diff --git a/docs/ref/api/stream.md b/docs/ref/api/stream.md
index a2f29238..3bed7923 100644
--- a/docs/ref/api/stream.md
+++ b/docs/ref/api/stream.md
@@ -103,7 +103,6 @@ nng_err nng_stream_get_string(nng_stream *s, const char *opt, const char **valp)
{{hi:`nng_stream_get_int`}}
{{hi:`nng_stream_get_ms`}}
{{hi:`nng_stream_get_size`}}
-{{hi:`nng_stream_get_addr`}}
{{hi:`nng_stream_get_string`}}
These functions are used to obtain value of an option named _opt_ from the stream _s_, and store it in the location
referenced by _valp_.
@@ -114,10 +113,6 @@ are available, and which type they may be accessed using.
In the case of `nng_stream_get_string`, the string pointer is only guaranteed to be valid while the
stream exists. Callers should make a copy of the data if required before closing the stream.
-> [!NOTE]:
-> The `nng_stream_get_addr` function is deprecated and will be removed. Use the
-> [`nng_stream_peer_addr`] or [`nng_stream_self_addr`] functions instead.
-
## Stream Factories
```c