From e8d6c2bf692dbcb4c503caa676314a6a626a8a68 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 14 Oct 2024 18:08:13 -0700 Subject: Converted protocols to mdbook. Started an introductory section too. --- docs/ref/proto/pub.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/ref/proto/pub.md (limited to 'docs/ref/proto/pub.md') diff --git a/docs/ref/proto/pub.md b/docs/ref/proto/pub.md new file mode 100644 index 00000000..40a75706 --- /dev/null +++ b/docs/ref/proto/pub.md @@ -0,0 +1,42 @@ +# PUB Protocol + +The {{i:*PUB* protocol}}{{hi:*PUB*}} is one half of a {{i: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 +[_SUB_](sub.md) protocol is the subscriber side. + +> [!NOTE] +> 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_pub0_open()`][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. +(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. + +[nng_pub_open]: TODO.md -- cgit v1.2.3-70-g09d2