aboutsummaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-03 08:38:22 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-03 08:49:33 -0800
commit4367013d8b56105edd0d27d0b9b6da2becab9717 (patch)
tree1bc6abaaff5b010adc415b3ab25698b59e73f353 /docs/ref
parent8249242a9325a27e57107d78bfa168e918cc4f7a (diff)
downloadnng-4367013d8b56105edd0d27d0b9b6da2becab9717.tar.gz
nng-4367013d8b56105edd0d27d0b9b6da2becab9717.tar.bz2
nng-4367013d8b56105edd0d27d0b9b6da2becab9717.zip
Remove untyped stream option functions.
The underlying stream APIs have no need for untyped accessors. Another step on the road to removal of NNI_TYPE_OPAQUE.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/migrate/nng1.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md
index 65af2382..9d9cd01b 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -54,6 +54,19 @@ The `_getopt` and `_setopt` functions for contexts, listeners, and dialers are n
present. Simply changing `_getopt` to `_get` or `_setopt` to `_set` in the function name
should be sufficient in most cases.
+## Untyped Option Functions Removed
+
+The following functions are removed. To access options, use a proper typed access function,
+such as one ending in a suffix like `_bool` (to access a `bool` typed option).
+
+- `nng_pipe_get`
+- `nng_stream_get`
+- `nng_stream_set`
+- `nng_stream_dialer_get`
+- `nng_stream_dialer_set`
+- `nng_stream_listener_get`
+- `nng_stream_listener_set`
+
## Stream Options
The ability to set options on streams after they have been created is no longer present.