|
seqeron 0.18.0
|
Carries one message from the cluster stream. More...
#include <org/limitless/seqeron/protocol/SequencedFrame.hpp>
Public Attributes | |
| std::int64_t | clusterSeqNo |
| std::int64_t | groupSeqNo |
| this frame's place on its queue: 1 for the first, then one per frame (F-6) | |
| std::int32_t | sourceId |
| Fixed constant identifying the submitting producer process (header.sourceId) | |
| std::int32_t | connectionId |
| Connection id at that producer; routes the reply (header.connectionId) | |
| std::uint16_t | groupMask |
| the groups whose queues carry it (header.groupMask); 0 on a system frame | |
| std::int64_t | sourceSessionId |
| Aeron Cluster client session id (header.sessionId) | |
| std::int64_t | clusterTimestampNs |
| cluster consensus time (epoch ns) when message was committed | |
| std::int64_t | receiveTimeNs |
| wall-clock ns at receipt by this client | |
| bool | system |
| true: a system frame, named by systemEventType, and payloadId means nothing | |
| std::uint16_t | payloadId |
| which protocol templateId belongs to; 0 on a system frame | |
| std::uint16_t | systemEventType |
| which of §7's eighteen events; 0 on an application frame | |
| std::uint16_t | templateId |
| the message's messageHeader templateId; picks the specific decode | |
| std::uint16_t | blockLength |
| payload messageHeader blockLength; 0 on a system frame (see decodeSystem) | |
| std::uint16_t | version |
| payload messageHeader version; 0 on a system frame | |
| const char * | payload |
| the payload's own bytes, its 8-byte messageHeader included; on a system frame, the message with no framing at all | |
| std::uint64_t | payloadLength |
| total byte count | |
| std::int64_t | position |
| recording/stream position of this frame's first byte; pass to ReplayParams::position() to replay from here | |
Carries one message from the cluster stream.
Every fragment on the queue is one of seven messages (doc/seqeron-protocol-spec.md §4), and the same 2-byte field at offset 16 discriminates all of them: a Sequenced frame carries one opaque application payload named by payloadId, the six system messages carry seqeron's own vocabulary named by systemEventType. system says which. A consumer of an application frame dispatches on (payloadId, templateId) — never templateId alone, which is unique per schema only.
payload/payloadLength point into the Aeron fragment buffer and are valid only for the duration of the callback; payload addresses the start of the message (its own 8-byte messageHeader included). Copy the data before returning if it must survive.
| std::uint16_t org::limitless::seqeron::protocol::SequencedEvent::blockLength |
payload messageHeader blockLength; 0 on a system frame (see decodeSystem)
| std::int64_t org::limitless::seqeron::protocol::SequencedEvent::clusterSeqNo |
| std::int64_t org::limitless::seqeron::protocol::SequencedEvent::clusterTimestampNs |
cluster consensus time (epoch ns) when message was committed
| std::int32_t org::limitless::seqeron::protocol::SequencedEvent::connectionId |
Connection id at that producer; routes the reply (header.connectionId)
| std::uint16_t org::limitless::seqeron::protocol::SequencedEvent::groupMask |
the groups whose queues carry it (header.groupMask); 0 on a system frame
| std::int64_t org::limitless::seqeron::protocol::SequencedEvent::groupSeqNo |
this frame's place on its queue: 1 for the first, then one per frame (F-6)
| const char* org::limitless::seqeron::protocol::SequencedEvent::payload |
the payload's own bytes, its 8-byte messageHeader included; on a system frame, the message with no framing at all
| std::uint16_t org::limitless::seqeron::protocol::SequencedEvent::payloadId |
which protocol templateId belongs to; 0 on a system frame
| std::uint64_t org::limitless::seqeron::protocol::SequencedEvent::payloadLength |
total byte count
| std::int64_t org::limitless::seqeron::protocol::SequencedEvent::position |
recording/stream position of this frame's first byte; pass to ReplayParams::position() to replay from here
| std::int64_t org::limitless::seqeron::protocol::SequencedEvent::receiveTimeNs |
wall-clock ns at receipt by this client
| std::int32_t org::limitless::seqeron::protocol::SequencedEvent::sourceId |
Fixed constant identifying the submitting producer process (header.sourceId)
| std::int64_t org::limitless::seqeron::protocol::SequencedEvent::sourceSessionId |
Aeron Cluster client session id (header.sessionId)
| bool org::limitless::seqeron::protocol::SequencedEvent::system |
true: a system frame, named by systemEventType, and payloadId means nothing
| std::uint16_t org::limitless::seqeron::protocol::SequencedEvent::systemEventType |
which of §7's eighteen events; 0 on an application frame
| std::uint16_t org::limitless::seqeron::protocol::SequencedEvent::templateId |
the message's messageHeader templateId; picks the specific decode
| std::uint16_t org::limitless::seqeron::protocol::SequencedEvent::version |
payload messageHeader version; 0 on a system frame