From 3079d4aa9bbbca02c36dcb7ff6a3f6d24bd21189 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 9 Nov 2018 19:59:29 -0800 Subject: man page updates for 1.1.0 --- man/v1.1.0/nng_sub.7.html | 650 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 650 insertions(+) create mode 100644 man/v1.1.0/nng_sub.7.html (limited to 'man/v1.1.0/nng_sub.7.html') diff --git a/man/v1.1.0/nng_sub.7.html b/man/v1.1.0/nng_sub.7.html new file mode 100644 index 00000000..9209298a --- /dev/null +++ b/man/v1.1.0/nng_sub.7.html @@ -0,0 +1,650 @@ +--- +version: 1.1.0 +layout: refman +--- + + + + + + + +nng_sub(7) + + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+#include <nng/protocol/pubsub0/sub.h>
+
+
+
+
+
+

DESCRIPTION

+
+
+

+The sub protocol is one half of a publisher/subscriber pattern. +In this pattern, a publisher sends data, which is broadcast to all subscribers. +The subscribing applications only see the data to which they have subscribed.

+
+
+

The sub protocol is the subscriber side, and the +pub protocol is the publisher side.

+
+
+ + + + + +
+ + +In this implementation, the publisher delivers all messages to all +subscribers. +The subscribers maintain their own subscriptions, and filter them locally. +Thus, this pattern should not be used in an attempt to +reduce bandwidth consumption. +
+
+
+

The topics that subscribers subscribe to is just the first part of +the message body. +Applications should construct their messages accordingly.

+
+
+

Socket Operations

+
+

The nng_sub0_open() functions create a subscriber socket. +This socket may be used to receive messages, but is unable to send them. +Attempts to send messages will result in NNG_ENOTSUP.

+
+
+
+

Protocol Versions

+
+

Only version 0 of this protocol is supported. +(At the time of writing, no other versions of this protocol have been defined.)

+
+
+
+

Protocol Options

+
+

The following protocol-specific options are available.

+
+
+
+
NNG_OPT_SUB_SUBSCRIBE
+
+

This option registers a topic that the subscriber is interested in. +The option is write-only, and takes an array of bytes, of arbitrary size. +Each incoming message is checked against the list of subscribed topics. +If the body begins with the entire set of bytes in the topic, then the +message is accepted. If no topic matches, then the message is +discarded.

+
+ + + + + +
+ + +To receive all messages, an empty topic (zero length) can be used. +
+
+
+
NNG_OPT_SUB_UNSUBSCRIBE
+
+

This option, also read-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.

+
+
+
+
+
+

Protocol Headers

+
+

The sub protocol has no protocol-specific headers.

+
+
+
+
+
+

SEE ALSO

+
+
+

nng_sub_open(3), +nng_pub(7), +nng(7)

+
+
+
+
+ + -- cgit v1.2.3-70-g09d2