summaryrefslogtreecommitdiff
path: root/docs/ref/proto/pub.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-06 10:56:42 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-06 10:56:42 -0700
commitc6fc27fdbbdcff19a61ea35f99d85377e39f6566 (patch)
tree09da47f3a300e3d791d67e3a094ef4ea97a8cf25 /docs/ref/proto/pub.adoc
parente7fbde275f0966091484bb874b0281d2c78a8c3c (diff)
downloadnng-c6fc27fdbbdcff19a61ea35f99d85377e39f6566.tar.gz
nng-c6fc27fdbbdcff19a61ea35f99d85377e39f6566.tar.bz2
nng-c6fc27fdbbdcff19a61ea35f99d85377e39f6566.zip
Proto pages done.
Diffstat (limited to 'docs/ref/proto/pub.adoc')
-rw-r--r--docs/ref/proto/pub.adoc36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/ref/proto/pub.adoc b/docs/ref/proto/pub.adoc
new file mode 100644
index 00000000..1d46afb2
--- /dev/null
+++ b/docs/ref/proto/pub.adoc
@@ -0,0 +1,36 @@
+## Publisher Protocol (_PUB_)
+
+The ((_PUB_ protocol))(((protocol, _PUB_))) 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 _PUB_ protocol is the publisher side, and the xref:sub.adoc[_SUB_] protocol is the subscriber side.
+
+The publisher delivers all messages to all subscribers.
+The subscribers maintain their own subscriptions, and filter them locally.footnote:[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 xref:../sock/nng_pub_open.adoc[`nng_pub_open`] functions create a publisher socket.
+This socket may be used to send messages, but is unable to receive them.
+Attempts to receive messages will result in `NNG_ENOTSUP`.
+
+#### Protocol Versions
+
+Only version 0 of this protocol is supported.footnote:[At the time of writing, no other versions of this protocol have been defined.]
+
+#### Protocol Options
+
+The _PUB_ protocol has no protocol-specific options.
+
+#### Protocol Headers
+
+The _PUB_ protocol has no protocol-specific headers.
+
+### See Also
+
+xref:sub.adoc[Subscriber Protocol (_SUB_)],
+xref:../sock/nng_pub_open.adoc[nng_pub_open]