summaryrefslogtreecommitdiff
path: root/docs/man/nng_sub.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-09 09:25:22 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-11 10:31:44 -0800
commit3163a56e06a58abb10c753fc77da388234d580c2 (patch)
treea35a02af1590d94cedb5fbcaef7de535d8e5b73e /docs/man/nng_sub.7.adoc
parent18d7519234f456a487623d93bcb6daa121d0ce17 (diff)
downloadnng-3163a56e06a58abb10c753fc77da388234d580c2.tar.gz
nng-3163a56e06a58abb10c753fc77da388234d580c2.tar.bz2
nng-3163a56e06a58abb10c753fc77da388234d580c2.zip
Add nng_sub0_subscribe and friends.
These are new functions that replace `NNG_OPT_SUBSCRIBE` and `NNG_OPT_UNSUBSCRIBE`. They are provided here as a transition aid before those options are removed in NNG 2.0.
Diffstat (limited to 'docs/man/nng_sub.7.adoc')
-rw-r--r--docs/man/nng_sub.7.adoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/man/nng_sub.7.adoc b/docs/man/nng_sub.7.adoc
index a96c1217..95d7066e 100644
--- a/docs/man/nng_sub.7.adoc
+++ b/docs/man/nng_sub.7.adoc
@@ -65,6 +65,10 @@ The following protocol-specific options are available.
message is accepted. If no topic matches, then the message is
discarded.
+
+NOTE: This option is deprecated. New applications should use
+xref:nng_sub_subscribe.3.adoc[`nng_sub0_socket_subscribe`] or `nng_sub0_ctx_subscribe`
+functions.
++
NOTE: This option is a byte array. Thus if you use
xref:nng_setopt.3.adoc[`nng_setopt_string()`] the `NUL` terminator byte will
be included in the topic.
@@ -79,6 +83,10 @@ TIP: To receive all messages, an empty topic (zero length) can be used.
This option, also write-only, removes a topic from the subscription list.
Note that if the topic was not previously subscribed to with
`NNG_OPT_SUB_SUBSCRIBE` then an `NNG_ENOENT` error will result.
+ +
+ NOTE: This option is deprecated. New applications should use
+ xref:nng_sub_subscribe.3.adoc[`nng_sub0_socket_unsubscribe`] or `nng_sub0_ctx_unsubscribe`
+ functions.
((`NNG_OPT_SUB_PREFNEW`))::
@@ -95,5 +103,6 @@ The _sub_ protocol has no protocol-specific headers.
[.text-left]
xref:nng_sub_open.3.adoc[nng_sub_open(3)],
+xref:nng_sub_subscribe.3.adoc[nng_sub_subscribe(3)],
xref:nng_pub.7.adoc[nng_pub(7)],
xref:nng.7.adoc[nng(7)]