One frame off the queue, unwrapped: everything a consumer dispatches on, with the envelope stripped.
More...
#include <org/limitless/seqeron/protocol/SequencedFrame.hpp>
|
| bool | valid |
| | false for a fragment that is not a frame, or too short to read
|
| |
| bool | system |
| | true: one of the six system messages; payloadId/templateId mean nothing
|
| |
| std::uint16_t | payloadId |
| |
| std::uint16_t | systemEventType |
| |
| std::int32_t | sourceId |
| |
| std::int32_t | connectionId |
| |
| std::uint16_t | groupMask |
| | the groups whose queues carry it (header.groupMask, §7.4)
|
| |
| std::int64_t | sourceSessionId |
| | Aeron Cluster client session id (header.sessionId)
|
| |
| std::int64_t | clusterSeqNo |
| |
| std::int64_t | groupSeqNo |
| | this frame's place on its queue (header.groupSeqNo, F-6)
|
| |
| std::int64_t | clusterTimestampNs |
| | cluster consensus time (epoch ns) when committed (header.timestamp)
|
| |
| std::uint16_t | templateId |
| | application family: the payload's own, never the envelope's
|
| |
| std::uint16_t | blockLength |
| | The payload's own, to wrap its decoder with; both 0 on any system frame, whose message carries no declaration at all — its decoder's compiled constants are the only ones there are (V-3).
|
| |
| std::uint16_t | version |
| |
| const char * | payload |
| | What a consumer decodes: the payload, its 8-byte messageHeader included, on an application frame; the payload on a submitted system frame; the frame's own block on one of the synthesized five.
|
| |
| std::uint64_t | payloadLength |
| |
One frame off the queue, unwrapped: everything a consumer dispatches on, with the envelope stripped.
The two stream clients both build one of these and then differ only in what they do with it, which is the point: the envelope is stripped here, once, rather than at every consumer. The identity is the frame header's; what the message is depends on the family (see payload below).
◆ blockLength
| std::uint16_t org::limitless::seqeron::protocol::FrameView::blockLength |
The payload's own, to wrap its decoder with; both 0 on any system frame, whose message carries no declaration at all — its decoder's compiled constants are the only ones there are (V-3).
◆ clusterSeqNo
| std::int64_t org::limitless::seqeron::protocol::FrameView::clusterSeqNo |
◆ clusterTimestampNs
| std::int64_t org::limitless::seqeron::protocol::FrameView::clusterTimestampNs |
cluster consensus time (epoch ns) when committed (header.timestamp)
◆ connectionId
| std::int32_t org::limitless::seqeron::protocol::FrameView::connectionId |
◆ groupMask
| std::uint16_t org::limitless::seqeron::protocol::FrameView::groupMask |
the groups whose queues carry it (header.groupMask, §7.4)
◆ groupSeqNo
| std::int64_t org::limitless::seqeron::protocol::FrameView::groupSeqNo |
this frame's place on its queue (header.groupSeqNo, F-6)
◆ payload
| const char* org::limitless::seqeron::protocol::FrameView::payload |
What a consumer decodes: the payload, its 8-byte messageHeader included, on an application frame; the payload on a submitted system frame; the frame's own block on one of the synthesized five.
◆ payloadId
| std::uint16_t org::limitless::seqeron::protocol::FrameView::payloadId |
◆ payloadLength
| std::uint64_t org::limitless::seqeron::protocol::FrameView::payloadLength |
◆ sourceId
| std::int32_t org::limitless::seqeron::protocol::FrameView::sourceId |
◆ sourceSessionId
| std::int64_t org::limitless::seqeron::protocol::FrameView::sourceSessionId |
Aeron Cluster client session id (header.sessionId)
◆ system
| bool org::limitless::seqeron::protocol::FrameView::system |
true: one of the six system messages; payloadId/templateId mean nothing
◆ systemEventType
| std::uint16_t org::limitless::seqeron::protocol::FrameView::systemEventType |
◆ templateId
| std::uint16_t org::limitless::seqeron::protocol::FrameView::templateId |
application family: the payload's own, never the envelope's
◆ valid
| bool org::limitless::seqeron::protocol::FrameView::valid |
false for a fragment that is not a frame, or too short to read
◆ version
| std::uint16_t org::limitless::seqeron::protocol::FrameView::version |
The documentation for this struct was generated from the following file: