seqeron 0.18.0
Loading...
Searching...
No Matches
Org.Limitless.Seqeron.App.Payload Class Referencesealed

One application payload delivered in order, with the frame layer off it: the envelope is stripped, and BodyOffset strips the payload's own MessageHeader too, which is where an SBE decoder wraps. A payload that carries no header (spec §13.2) is addressed by PayloadOffset instead. More...

Properties

long ClusterSeqNo [get]
 Cluster-wide monotone sequence number; along this queue it increases, but not by one (spec F-6).
 
long GroupSeqNo [get]
 This frame's place on this instance's queue, increasing by exactly one per frame.
 
int SourceId [get]
 The producer that submitted this frame (spec §5).
 
int ConnectionId [get]
 The producer's connection this frame belongs to, or -1 for a producer-scoped one.
 
ushort GroupMask [get]
 The groups whose queues carry it; a reply to it takes this mask (spec A-2, A-9).
 
ReplyAddress ReplyAddress [get]
 The address a later Application.Reply(ReplyAddress, int, Adaptive.Agrona.IDirectBuffer, int) takes; unlike this payload, it outlives the callback.
 
long SourceSessionId [get]
 The cluster session it was submitted on; a gateway pair shares its SourceId but not this.
 
long ClusterTimestampNs [get]
 The Raft consensus timestamp, identical on every node.
 
long ReceiveTimeNs [get]
 When this process read it — a delivery stamp, not the frame's.
 
long Position [get]
 Where this frame's first byte sits in the node's recording — a delivery stamp too, and what a consumer that replays that recording itself (a FIX gateway serving its own resend) anchors on.
 
int PayloadId [get]
 Which protocol the body speaks (spec §13).
 
int TemplateId [get]
 The body's own template within that protocol.
 
int BlockLength [get]
 For the decoder's wrap, from the payload's own MessageHeader.
 
int Version [get]
 For the decoder's wrap, from the payload's own MessageHeader.
 
IDirectBuffer Buffer [get]
 The buffer the body sits in.
 
int PayloadOffset [get]
 Where the payload starts: past the envelope, its own MessageHeader included if it has one.
 
int PayloadLength [get]
 The payload's length from PayloadOffset.
 
int BodyOffset [get]
 Where the body starts: past the envelope and past the payload's own MessageHeader.
 
int BodyLength [get]
 The body's length from BodyOffset.
 

Detailed Description

One application payload delivered in order, with the frame layer off it: the envelope is stripped, and BodyOffset strips the payload's own MessageHeader too, which is where an SBE decoder wraps. A payload that carries no header (spec §13.2) is addressed by PayloadOffset instead.

Nothing of seqeron's own vocabulary reaches here — the system family is the façade's business, and a frame of it never arrives as a payload. What is left is the payload's identity in the total order (ClusterSeqNo), who sent it and on whose behalf (SourceId, ConnectionId), the consensus clock it was stamped with, and the bytes.

Dispatch on (PayloadId, TemplateId), never TemplateId alone: template ids are unique per schema, so two applications' templates can collide.

A flyweight: valid only during the handler call; copy anything that must outlive it.

Property Documentation

◆ BlockLength

int Org.Limitless.Seqeron.App.Payload.BlockLength
get

For the decoder's wrap, from the payload's own MessageHeader.

◆ BodyLength

int Org.Limitless.Seqeron.App.Payload.BodyLength
get

The body's length from BodyOffset.

◆ BodyOffset

int Org.Limitless.Seqeron.App.Payload.BodyOffset
get

Where the body starts: past the envelope and past the payload's own MessageHeader.

◆ Buffer

IDirectBuffer Org.Limitless.Seqeron.App.Payload.Buffer
get

The buffer the body sits in.

◆ ClusterSeqNo

long Org.Limitless.Seqeron.App.Payload.ClusterSeqNo
get

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

◆ ClusterTimestampNs

long Org.Limitless.Seqeron.App.Payload.ClusterTimestampNs
get

The Raft consensus timestamp, identical on every node.

◆ ConnectionId

int Org.Limitless.Seqeron.App.Payload.ConnectionId
get

The producer's connection this frame belongs to, or -1 for a producer-scoped one.

◆ GroupMask

ushort Org.Limitless.Seqeron.App.Payload.GroupMask
get

The groups whose queues carry it; a reply to it takes this mask (spec A-2, A-9).

◆ GroupSeqNo

long Org.Limitless.Seqeron.App.Payload.GroupSeqNo
get

This frame's place on this instance's queue, increasing by exactly one per frame.

◆ PayloadId

int Org.Limitless.Seqeron.App.Payload.PayloadId
get

Which protocol the body speaks (spec §13).

◆ PayloadLength

int Org.Limitless.Seqeron.App.Payload.PayloadLength
get

The payload's length from PayloadOffset.

◆ PayloadOffset

int Org.Limitless.Seqeron.App.Payload.PayloadOffset
get

Where the payload starts: past the envelope, its own MessageHeader included if it has one.

◆ Position

long Org.Limitless.Seqeron.App.Payload.Position
get

Where this frame's first byte sits in the node's recording — a delivery stamp too, and what a consumer that replays that recording itself (a FIX gateway serving its own resend) anchors on.

◆ ReceiveTimeNs

long Org.Limitless.Seqeron.App.Payload.ReceiveTimeNs
get

When this process read it — a delivery stamp, not the frame's.

◆ ReplyAddress

ReplyAddress Org.Limitless.Seqeron.App.Payload.ReplyAddress
get

The address a later Application.Reply(ReplyAddress, int, Adaptive.Agrona.IDirectBuffer, int) takes; unlike this payload, it outlives the callback.

◆ SourceId

int Org.Limitless.Seqeron.App.Payload.SourceId
get

The producer that submitted this frame (spec §5).

◆ SourceSessionId

long Org.Limitless.Seqeron.App.Payload.SourceSessionId
get

The cluster session it was submitted on; a gateway pair shares its SourceId but not this.

◆ TemplateId

int Org.Limitless.Seqeron.App.Payload.TemplateId
get

The body's own template within that protocol.

◆ Version

int Org.Limitless.Seqeron.App.Payload.Version
get

For the decoder's wrap, from the payload's own MessageHeader.


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