seqeron 0.18.0
Loading...
Searching...
No Matches
Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder Class Reference

One frame off the queue with the envelope stripped; SequencedFrameDecoder.java and FrameView in SequencedFrame.hpp are its twins, and the three stay in step. IsSystem says which family: an application frame dispatches on (PayloadId, TemplateId), never TemplateId alone, and a system frame on SystemEventType. More...

Inheritance diagram for Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder:

Public Member Functions

bool Wrap (IDirectBuffer source, int offset, int length)
 Reads one fragment, stripping the envelope. false means the fragment is not a whole frame (a damaged recording) and the caller drops it. It never reads past the fragment and never throws on its contents: Image.Poll advances past a fragment whose handler throws, so a throw would lose the frame silently.
 

Properties

bool IsSystem [get]
 Whether this frame is one of the system messages; if so PayloadId means nothing.
 
int PayloadId [get]
 Which protocol TemplateId belongs to; 0 on a system frame.
 
int SystemEventType [get]
 Which of §7's events this frame carries; 0 on an application frame.
 
int SourceId [get]
 Publishing producer process (header.sourceId); -1 on a frame the cluster synthesized.
 
int ConnectionId [get]
 Connection at that producer (header.connectionId); routes the reply.
 
int GroupMask [get]
 The groups whose queues carry the frame (header.groupMask); 0 on a system frame (§7.4).
 
long SourceSessionId [get]
 Cluster session the frame was submitted on (header.sessionId), as the sequencer stamped it.
 
long ClusterSeqNo [get]
 Cluster-wide monotone sequence number; along one queue it increases, but not by one (F-6).
 
long GroupSeqNo [get]
 This frame's place on its queue: 1 for the queue's first frame, increasing by exactly one per frame.
 
long ClusterTimestampNs [get]
 Cluster consensus time (epoch ns) at which the frame was committed (header.timestamp).
 
int TemplateId [get]
 The payload's own templateId, never the envelope's; 0 on a system frame.
 
int BlockLength [get]
 What to wrap a decoder over PayloadOffset with on an application frame: the payload's own. 0 on every system frame, whose decoder's compiled constants are the only ones there are (V-3).
 
int Version [get]
 See BlockLength.
 
IDirectBuffer Buffer [get]
 Buffer the frame sits in; valid only while the frame it was wrapped over is.
 
int PayloadOffset [get]
 Offset within Buffer of what a consumer decodes: the payload, its own 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.
 
int PayloadLength [get]
 Length in bytes of what PayloadOffset addresses; the envelope is not in it.
 

Detailed Description

One frame off the queue with the envelope stripped; SequencedFrameDecoder.java and FrameView in SequencedFrame.hpp are its twins, and the three stay in step. IsSystem says which family: an application frame dispatches on (PayloadId, TemplateId), never TemplateId alone, and a system frame on SystemEventType.

A flyweight: Buffer points into the caller's storage and every field is valid only until the next Wrap.

Member Function Documentation

◆ Wrap()

bool Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.Wrap ( IDirectBuffer  source,
int  offset,
int  length 
)
inline

Reads one fragment, stripping the envelope. false means the fragment is not a whole frame (a damaged recording) and the caller drops it. It never reads past the fragment and never throws on its contents: Image.Poll advances past a fragment whose handler throws, so a throw would lose the frame silently.

Parameters
sourcethe buffer the fragment is in
offsetof the fragment's first byte
lengthof the fragment
Returns
whether the fragment was readable as a frame

Property Documentation

◆ BlockLength

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.BlockLength
get

What to wrap a decoder over PayloadOffset with on an application frame: the payload's own. 0 on every system frame, whose decoder's compiled constants are the only ones there are (V-3).

◆ Buffer

IDirectBuffer Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.Buffer
get

Buffer the frame sits in; valid only while the frame it was wrapped over is.

◆ ClusterSeqNo

long Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.ClusterSeqNo
get

Cluster-wide monotone sequence number; along one queue it increases, but not by one (F-6).

◆ ClusterTimestampNs

long Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.ClusterTimestampNs
get

Cluster consensus time (epoch ns) at which the frame was committed (header.timestamp).

◆ ConnectionId

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.ConnectionId
get

Connection at that producer (header.connectionId); routes the reply.

◆ GroupMask

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.GroupMask
get

The groups whose queues carry the frame (header.groupMask); 0 on a system frame (§7.4).

◆ GroupSeqNo

long Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.GroupSeqNo
get

This frame's place on its queue: 1 for the queue's first frame, increasing by exactly one per frame.

◆ IsSystem

bool Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.IsSystem
get

Whether this frame is one of the system messages; if so PayloadId means nothing.

◆ PayloadId

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.PayloadId
get

Which protocol TemplateId belongs to; 0 on a system frame.

◆ PayloadLength

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.PayloadLength
get

Length in bytes of what PayloadOffset addresses; the envelope is not in it.

◆ PayloadOffset

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.PayloadOffset
get

Offset within Buffer of what a consumer decodes: the payload, its own 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.

◆ SourceId

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.SourceId
get

Publishing producer process (header.sourceId); -1 on a frame the cluster synthesized.

◆ SourceSessionId

long Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.SourceSessionId
get

Cluster session the frame was submitted on (header.sessionId), as the sequencer stamped it.

◆ SystemEventType

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.SystemEventType
get

Which of §7's events this frame carries; 0 on an application frame.

◆ TemplateId

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.TemplateId
get

The payload's own templateId, never the envelope's; 0 on a system frame.

◆ Version

int Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder.Version
get

See BlockLength.


The documentation for this class was generated from the following file: