diff options
| author | wrobell <wrobell@riseup.net> | 2021-11-24 18:26:25 +0000 |
|---|---|---|
| committer | wrobell <wrobell@riseup.net> | 2021-11-24 18:34:55 +0000 |
| commit | 07dc62af7c914c639e55a58be5c52f5813fb50e4 (patch) | |
| tree | 958dd241d9f9630c25cb69c4d30ac12e2c29885a | |
| parent | b4f39031f6cf2dadf522a56507364d24d0faf200 (diff) | |
| download | rabbitmq-server-git-07dc62af7c914c639e55a58be5c52f5813fb50e4.tar.gz | |
Link to most recent description of Osiris chunk format
The most recent description of Osiris chunk format does not reference
the timestamp field to be "posix-ish" anymore. This was bit misleading
as it is Erlang's system time.
Add link to Erlang system time documentation to the subscription command
description to avoid confusion about the timestamp field.
| -rw-r--r-- | deps/rabbitmq_stream/docs/PROTOCOL.adoc | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/deps/rabbitmq_stream/docs/PROTOCOL.adoc b/deps/rabbitmq_stream/docs/PROTOCOL.adoc index 34786dad30..60a8e48d3e 100644 --- a/deps/rabbitmq_stream/docs/PROTOCOL.adoc +++ b/deps/rabbitmq_stream/docs/PROTOCOL.adoc @@ -322,6 +322,9 @@ Subscribe => Key Version CorrelationId SubscriptionId Stream OffsetSpecification Value => string ``` +NB: Timestamp is https://www.erlang.org/doc/apps/erts/time_correction.html#Erlang_System_Time[Erlang system time], +milliseconds from epoch + === Deliver ``` @@ -334,7 +337,7 @@ Deliver => Key Version SubscriptionId OsirisChunk ChunkType => int8 // 0: user, 1: tracking delta, 2: tracking snapshot NumEntries => uint16 NumRecords => uint32 - Timestamp => int64 // in milliseconds, since epoch + Timestamp => int64 // erlang system time in milliseconds, since epoch Epoch => uint64 ChunkFirstOffset => uint64 ChunkCrc => int32 @@ -346,7 +349,7 @@ Deliver => Key Version SubscriptionId OsirisChunk Data => bytes ``` -NB: See the https://github.com/rabbitmq/osiris/blob/348db0528986d6025b823bcf1ae0570aa63f5e25/src/osiris_log.erl#L49-L81[Osiris project] +NB: See the https://github.com/rabbitmq/osiris/blob/f32df7563a036b1687c0208a3cb5f9e8f5cee937/src/osiris_log.erl#L101[Osiris project] for details on the structure of messages. === Credit |