aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-03 00:51:15 -0700
committerGarrett D'Amore <garrett@damore.org>2024-11-03 00:58:37 -0700
commitb3fc8a44119d7ab90366a1b92a5e1327ebcb8145 (patch)
tree994c0199184fdea3d56eeb61b252e10733588947 /docs
parent02ec0b55cbee5de4d0fd688ce0ebddf08178dc98 (diff)
downloadnng-b3fc8a44119d7ab90366a1b92a5e1327ebcb8145.tar.gz
nng-b3fc8a44119d7ab90366a1b92a5e1327ebcb8145.tar.bz2
nng-b3fc8a44119d7ab90366a1b92a5e1327ebcb8145.zip
Replace NNG_OPT_SUB_SUBSCRIBE/UNSUBSCRIBE with functions.
The main purpose is to eliminate the NNI_TYPE_OPAQUE options, by putting these into their own first class, protocol-specific, functions.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/migrate/nanomsg.md2
-rw-r--r--docs/ref/migrate/nng1.md7
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/ref/migrate/nanomsg.md b/docs/ref/migrate/nanomsg.md
index 695f771b..67e6505a 100644
--- a/docs/ref/migrate/nanomsg.md
+++ b/docs/ref/migrate/nanomsg.md
@@ -84,6 +84,8 @@ The following options are changed.
| `NN_IPV4ONLY` | None | Use URL such as `tcp4://` to obtain this functionality. |
| `NN_SOCKET_NAME` | `NNG_OPT_SOCKNAME` |
| `NN_MAXTTL` | `NNG_OPT_MAXTTL` |
+| `NN_SUB_SUBSCRIBE` | `nng_sub0_socket_subscribe` | No longer an option, use a function call. |
+| `NN_SUB_UNSUBSCRIBE` | `nng_sub0_socket_unsubscribe` | No longer an option, use a function call. |
## Error Codes
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md
index 3004b880..65af2382 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -80,6 +80,13 @@ matching the actual wire protocol values, instead of `int`.
The `NNG_OPT_RAW` option has aso been replaced by a function, `nng_socket_raw`.
+## Subscriptions
+
+The `NNG_OPT_SUB_SUBSCRIBE` and `NNG_OPT_SUB_UNSUBCRIBE` options have been replaced by
+the following functions: `nng_sub0_socket_subscribe`, `nng_sub0_socket_unsubscribe`,
+`nng_sub0_ctx_subscribe` and `nng_sub0_ctx_unsubscribe`. These functions, like the options
+they replace, are only applicable to SUB sockets.
+
## Statistics Use Constified Pointers
A number of the statistics functions take, or return, `const nng_stat *` instead