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

The frame layer's constants: the queue's identity, the cluster clock, and the size limits of spec §12. The C# mirror of the spec, as FrameLayer.java and SequencedFrame.hpp are; a change is a wire change (V-3) and lands in all three. Never read from a transport: S-3 forbids checking a node's own MTU, which would fork clusterSeqNo. More...

Static Public Member Functions

static int QueueStreamIdOf (int groupId)
 The stream id of a group's queue.
 

Static Public Attributes

const int MaxPayloadLength = 8874
 Largest payload any frame may carry (T-2): an 8960-byte IPC MTU, one jumbo frame, less the 86 bytes of Aeron data header and sequenced envelope, so a queue whose MTU is that large never fragments.
 
const int MinIngressLength = MessageHeader.Size + UnsequencedHeader.Size + Unsequenced.PayloadHeaderSize
 Smallest ingress frame of either family, 30 bytes: framing header, 20-byte header composite and the payload's 2-byte length prefix. An empty payload is legal.
 
const int MaxIngressLength = MinIngressLength + MaxPayloadLength
 Largest ingress frame: a full payload behind that framing, 8904 bytes. §9.2 condition 1's ceiling.
 
const string QueueChannel = "aeron:ipc?alias=seqeron-queue"
 The queue: the node-local IPC stream every node republishes each sequenced frame on, in clusterSeqNo order, and records into its own archive. Co-located apps follow it live. Each group's queue is this channel on its own stream, QueueStreamIdOf.
 
const int MaxGroups = 16
 The width of groupMask: groupIds run 1 to 16.
 
const int QueueStreamIdBase = 2000
 Group groupId's queue is stream QueueStreamIdBase + groupId.
 
const long ClusterHeartbeatIntervalMs = 1000
 Period of the cluster clock: every node emits a ClusterHeartbeat carrying the consensus timestamp, so consumers have a clock that advances while producers are silent. A consumer's queue watchdog must span whole periods.
 
const long ClusterHeartbeatIntervalNs = ClusterHeartbeatIntervalMs * 1_000_000
 ClusterHeartbeatIntervalMs in consensus time, which is epoch nanoseconds.
 

Detailed Description

The frame layer's constants: the queue's identity, the cluster clock, and the size limits of spec §12. The C# mirror of the spec, as FrameLayer.java and SequencedFrame.hpp are; a change is a wire change (V-3) and lands in all three. Never read from a transport: S-3 forbids checking a node's own MTU, which would fork clusterSeqNo.

Member Function Documentation

◆ QueueStreamIdOf()

static int Org.Limitless.Seqeron.Protocol.FrameLayer.QueueStreamIdOf ( int  groupId)
inlinestatic

The stream id of a group's queue.

Parameters
groupId1 to MaxGroups

Member Data Documentation

◆ ClusterHeartbeatIntervalMs

const long Org.Limitless.Seqeron.Protocol.FrameLayer.ClusterHeartbeatIntervalMs = 1000
static

Period of the cluster clock: every node emits a ClusterHeartbeat carrying the consensus timestamp, so consumers have a clock that advances while producers are silent. A consumer's queue watchdog must span whole periods.

◆ ClusterHeartbeatIntervalNs

const long Org.Limitless.Seqeron.Protocol.FrameLayer.ClusterHeartbeatIntervalNs = ClusterHeartbeatIntervalMs * 1_000_000
static

ClusterHeartbeatIntervalMs in consensus time, which is epoch nanoseconds.

◆ MaxGroups

const int Org.Limitless.Seqeron.Protocol.FrameLayer.MaxGroups = 16
static

The width of groupMask: groupIds run 1 to 16.

◆ MaxIngressLength

const int Org.Limitless.Seqeron.Protocol.FrameLayer.MaxIngressLength = MinIngressLength + MaxPayloadLength
static

Largest ingress frame: a full payload behind that framing, 8904 bytes. §9.2 condition 1's ceiling.

◆ MaxPayloadLength

const int Org.Limitless.Seqeron.Protocol.FrameLayer.MaxPayloadLength = 8874
static

Largest payload any frame may carry (T-2): an 8960-byte IPC MTU, one jumbo frame, less the 86 bytes of Aeron data header and sequenced envelope, so a queue whose MTU is that large never fragments.

◆ MinIngressLength

const int Org.Limitless.Seqeron.Protocol.FrameLayer.MinIngressLength = MessageHeader.Size + UnsequencedHeader.Size + Unsequenced.PayloadHeaderSize
static

Smallest ingress frame of either family, 30 bytes: framing header, 20-byte header composite and the payload's 2-byte length prefix. An empty payload is legal.

◆ QueueChannel

const string Org.Limitless.Seqeron.Protocol.FrameLayer.QueueChannel = "aeron:ipc?alias=seqeron-queue"
static

The queue: the node-local IPC stream every node republishes each sequenced frame on, in clusterSeqNo order, and records into its own archive. Co-located apps follow it live. Each group's queue is this channel on its own stream, QueueStreamIdOf.

◆ QueueStreamIdBase

const int Org.Limitless.Seqeron.Protocol.FrameLayer.QueueStreamIdBase = 2000
static

Group groupId's queue is stream QueueStreamIdBase + groupId.


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