seqeron 0.18.0
Loading...
Searching...
No Matches
Org.Limitless.Seqeron.Replayer.Client.SequencedEvent Class Referencesealed

One frame delivered in order off the sequenced stream, live or replayed; SequencedEvent.java and the C++ SequencedEvent are its twins. The envelope is stripped: split on SequencedFrameDecoder.IsSystem, then dispatch on (PayloadId, TemplateId) or SequencedFrameDecoder.SystemEventType. Every system frame but LeadershipChanged, which has its own callback, arrives here. More...

Inheritance diagram for Org.Limitless.Seqeron.Replayer.Client.SequencedEvent:
Collaboration diagram for Org.Limitless.Seqeron.Replayer.Client.SequencedEvent:

Properties

long ReceiveTimeNs [get]
 Wall-clock ns at receipt by this client.
 
long Position [get]
 Recording/stream position of this frame's first byte: what a resumed replay is anchored on.
 
- Properties inherited from Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder
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.
 

Additional Inherited Members

- Public Member Functions inherited from Org.Limitless.Seqeron.Protocol.SequencedFrameDecoder
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.
 

Detailed Description

One frame delivered in order off the sequenced stream, live or replayed; SequencedEvent.java and the C++ SequencedEvent are its twins. The envelope is stripped: split on SequencedFrameDecoder.IsSystem, then dispatch on (PayloadId, TemplateId) or SequencedFrameDecoder.SystemEventType. Every system frame but LeadershipChanged, which has its own callback, arrives here.

A flyweight: the buffer and every field are valid only during the handler call; copy to keep.

Property Documentation

◆ Position

long Org.Limitless.Seqeron.Replayer.Client.SequencedEvent.Position
get

Recording/stream position of this frame's first byte: what a resumed replay is anchored on.

◆ ReceiveTimeNs

long Org.Limitless.Seqeron.Replayer.Client.SequencedEvent.ReceiveTimeNs
get

Wall-clock ns at receipt by this client.


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