AtHeartEngineer/specs
1
0
Fork 0
mirror of https://github.com/vacp2p/specs.git synced 2026-01-09 15:28:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

pubsub: define 'origin-stamped' term.

Browse Source
This commit is contained in:
Raúl Kripalani
2020-09-25 16:00:06 +01:00
parent 03a68d53eb
commit b3c498ebad
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
pubsub/README.md
View File

@@ -124,18 +124,20 @@ initially authored the message, and NOT the peer who propagated it. Thus, as
the message is routed through a swarm of pubsubbing peers, the original the message is routed through a swarm of pubsubbing peers, the original
authorship is preserved. authorship is preserved.
The `data` field is an opaque blob of data representing the payload. It can
contain any data that the publisher wants it to.
The `seqno` field is a 64-bit big-endian uint that is a linearly increasing The `seqno` field is a 64-bit big-endian uint that is a linearly increasing
number that is unique among messages originating from each given peer. No two number that is unique among messages originating from each given peer. No two
messages on a pubsub topic from the same peer should have the same `seqno` messages on a pubsub topic from the same peer should have the same `seqno`
value, however messages from different peers may (and likely will) have the same value, however messages from different peers may (and likely will) have the same
sequence number, so this number alone cannot be used to address messages by sequence number. In other words, this number is not globally unique. It is used
**origin-stamping**. In other words, this number is not globally unique. It is in conjunction with `from` to derive a unique `message_id` (in the default
used in conjunction with `from` to derive a unique `message_id` (in the default
configuration). configuration).
Henceforth, we define the term **origin-stamped messaging** to refer to messages
whose `from` and `seqno` fields are populated.
The `data` field is an opaque blob of data representing the payload. It can
contain any data that the publisher wants it to.
The `topicIDs` field specifies a set of topics that this message is being The `topicIDs` field specifies a set of topics that this message is being
published to. published to.