The ingress side of the frame layer: wraps an already-encoded payload in its family's envelope and returns the length; the offer is the caller's. A system payload carries no MessageHeader: it is encoded bare, and decoded with its codec's compiled constants (§7, V-3).
More...
|
| int | Wrap (IMutableDirectBuffer frame, int sourceId, int connectionId, long sessionId, int systemEventType, IDirectBuffer body, int bodyLength) |
| | Encodes one UnsequencedSystem frame around body .
|
| |
| int | WrapPayload (IMutableDirectBuffer frame, int sourceId, int connectionId, long sessionId, int payloadId, int groupMask, IDirectBuffer payload, int payloadLength) |
| | The same, for an application's own payload rather than a system event's.
|
| |
|
| static int | IngressBlockLength (int systemEventType) |
| | The compiled block length of the event systemEventType names, or NotIngressLegal if it is unallocated or synthesis-only: §9.2 conditions 8 and 9 in one lookup.
|
| |
|
| const int | Refused = -1 |
| | Returned instead of a length when the payload is above FrameLayer.MaxPayloadLength, or the frame breaks §9.2 conditions 6 to 9: the checks a producer can make without the sequencer's state, so a frame the sequencer would drop is never sent (T-3). Local and permanent: nothing was encoded, and retrying cannot succeed.
|
| |
| const int | NotIngressLegal = -1 |
| | IngressBlockLength's answer for a systemEventType that may not be submitted.
|
| |
| const int | ConnectionOpened = Frame.ConnectionOpened.TemplateId |
| | A connection opened at a producer; header.connectionId names it.
|
| |
| const int | ConnectionClosed = Frame.ConnectionClosed.TemplateId |
| | A connection closed at a producer; header.connectionId names it.
|
| |
| const int | LeadershipChanged = 5 |
| | Synthesis-only; LeadershipChanged.TemplateId is the frame's, not this.
|
| |
| const int | ClusterStarted = Frame.ClusterStarted.TemplateId |
| | Operator marker: the cluster is up and open for the day.
|
| |
| const int | ClusterStopped = Frame.ClusterStopped.TemplateId |
| | Operator marker: an orderly shutdown, the last business event in the log.
|
| |
| const int | ClusterHeartbeat = 16 |
| | Synthesis-only.
|
| |
| const int | GatewayRegistered = Frame.GatewayRegistered.TemplateId |
| | One row of the topology list, and its remaining is the completeness edge.
|
| |
| const int | GatewayActive = 18 |
| | Synthesis-only. An operator asks for one with GatewayActivationRequested.
|
| |
| const int | GatewayStarted = Frame.GatewayStarted.TemplateId |
| | A gateway instance announcing itself, which binds its session to its gatewayId.
|
| |
| const int | PayloadIdRegistered = Frame.PayloadIdRegistered.TemplateId |
| | One payloadId's name in this deployment; labelling only.
|
| |
| const int | GatewayActivationRequested = Frame.GatewayActivationRequested.TemplateId |
| | An operator asking for one instance to be made active.
|
| |
| const int | ApplicationRegistered = Frame.ApplicationRegistered.TemplateId |
| | One co-located application's row; labelling only, and no election behind it.
|
| |
| const int | SnapshotRequested = Frame.SnapshotRequested.TemplateId |
| | An operator asking for a snapshot round.
|
| |
| const int | SnapshotEnd = Frame.SnapshotEnd.TemplateId |
| | A source's snapshot of one round: its digest, the bytes staying with each instance.
|
| |
| const int | SnapshotPolicyRegistered = Frame.SnapshotPolicyRegistered.TemplateId |
| | The topology file's snapshot policy.
|
| |
| const int | SnapshotStarted = 30 |
| | Synthesis-only; SnapshotStarted.TemplateId is the frame's, not this.
|
| |
| const int | SessionClosed = 31 |
| | Synthesis-only; SessionClosed.TemplateId is the frame's, not this.
|
| |
| const int | GroupsRegistered = Frame.GroupsRegistered.TemplateId |
| | The topology file's group table; the first activates the groups.
|
| |
The ingress side of the frame layer: wraps an already-encoded payload in its family's envelope and returns the length; the offer is the caller's. A system payload carries no MessageHeader: it is encoded bare, and decoded with its codec's compiled constants (§7, V-3).
Not thread-safe: one instance per producing thread, reusing its encoders.
◆ IngressBlockLength()
| static int Org.Limitless.Seqeron.Protocol.SystemFrame.IngressBlockLength |
( |
int |
systemEventType | ) |
|
|
inlinestatic |
The compiled block length of the event systemEventType names, or NotIngressLegal if it is unallocated or synthesis-only: §9.2 conditions 8 and 9 in one lookup.
- Parameters
-
| systemEventType | the event a frame names |
◆ Wrap()
| int Org.Limitless.Seqeron.Protocol.SystemFrame.Wrap |
( |
IMutableDirectBuffer |
frame, |
|
|
int |
sourceId, |
|
|
int |
connectionId, |
|
|
long |
sessionId, |
|
|
int |
systemEventType, |
|
|
IDirectBuffer |
body, |
|
|
int |
bodyLength |
|
) |
| |
|
inline |
Encodes one UnsequencedSystem frame around body .
- Parameters
-
| frame | where the frame is written, from offset 0 |
| sourceId | the producing process's gatewaySourceId; -1 is reserved for the cluster |
| connectionId | the connection this frame belongs to, or -1 for a producer-scoped one |
| sessionId | this process's cluster session; advisory, the sequencer overwrites it |
| systemEventType | which of §7's submitted events body holds |
| body | the event's SBE block, with no MessageHeader of its own |
| bodyLength | bytes of body to carry |
- Returns
- the frame's length in bytes, or Refused if bodyLength is above FrameLayer.MaxPayloadLength or the frame breaks §9.2 condition 6, 8 or 9
◆ WrapPayload()
| int Org.Limitless.Seqeron.Protocol.SystemFrame.WrapPayload |
( |
IMutableDirectBuffer |
frame, |
|
|
int |
sourceId, |
|
|
int |
connectionId, |
|
|
long |
sessionId, |
|
|
int |
payloadId, |
|
|
int |
groupMask, |
|
|
IDirectBuffer |
payload, |
|
|
int |
payloadLength |
|
) |
| |
|
inline |
The same, for an application's own payload rather than a system event's.
- Parameters
-
| frame | where the frame is written, from offset 0 |
| sourceId | the producing process's gatewaySourceId; -1 is reserved for the cluster |
| connectionId | the connection this frame belongs to, or -1 for a producer-scoped one |
| sessionId | this process's cluster session; advisory, the sequencer overwrites it |
| payloadId | names the payload's decoder namespace and encoding; 0 and 1 are invalid on the wire |
| groupMask | the groups whose queues the frame reaches, the producer's own included (§7.4) |
| payload | the payload, its own 8-byte MessageHeader included |
| payloadLength | bytes of payload to carry |
- Returns
- the frame's length in bytes, or Refused if payloadLength is above FrameLayer.MaxPayloadLength or the frame breaks §9.2 condition 6 or 7
◆ ApplicationRegistered
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.ApplicationRegistered = Frame.ApplicationRegistered.TemplateId |
|
static |
One co-located application's row; labelling only, and no election behind it.
◆ ClusterHeartbeat
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.ClusterHeartbeat = 16 |
|
static |
◆ ClusterStarted
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.ClusterStarted = Frame.ClusterStarted.TemplateId |
|
static |
Operator marker: the cluster is up and open for the day.
◆ ClusterStopped
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.ClusterStopped = Frame.ClusterStopped.TemplateId |
|
static |
Operator marker: an orderly shutdown, the last business event in the log.
◆ ConnectionClosed
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.ConnectionClosed = Frame.ConnectionClosed.TemplateId |
|
static |
A connection closed at a producer; header.connectionId names it.
◆ ConnectionOpened
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.ConnectionOpened = Frame.ConnectionOpened.TemplateId |
|
static |
A connection opened at a producer; header.connectionId names it.
◆ GatewayActivationRequested
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.GatewayActivationRequested = Frame.GatewayActivationRequested.TemplateId |
|
static |
An operator asking for one instance to be made active.
◆ GatewayActive
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.GatewayActive = 18 |
|
static |
Synthesis-only. An operator asks for one with GatewayActivationRequested.
◆ GatewayRegistered
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.GatewayRegistered = Frame.GatewayRegistered.TemplateId |
|
static |
One row of the topology list, and its remaining is the completeness edge.
◆ GatewayStarted
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.GatewayStarted = Frame.GatewayStarted.TemplateId |
|
static |
A gateway instance announcing itself, which binds its session to its gatewayId.
◆ GroupsRegistered
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.GroupsRegistered = Frame.GroupsRegistered.TemplateId |
|
static |
The topology file's group table; the first activates the groups.
◆ LeadershipChanged
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.LeadershipChanged = 5 |
|
static |
Synthesis-only; LeadershipChanged.TemplateId is the frame's, not this.
◆ NotIngressLegal
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.NotIngressLegal = -1 |
|
static |
IngressBlockLength's answer for a systemEventType that may not be submitted.
◆ PayloadIdRegistered
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.PayloadIdRegistered = Frame.PayloadIdRegistered.TemplateId |
|
static |
One payloadId's name in this deployment; labelling only.
◆ Refused
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.Refused = -1 |
|
static |
Returned instead of a length when the payload is above FrameLayer.MaxPayloadLength, or the frame breaks §9.2 conditions 6 to 9: the checks a producer can make without the sequencer's state, so a frame the sequencer would drop is never sent (T-3). Local and permanent: nothing was encoded, and retrying cannot succeed.
◆ SessionClosed
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.SessionClosed = 31 |
|
static |
Synthesis-only; SessionClosed.TemplateId is the frame's, not this.
◆ SnapshotEnd
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.SnapshotEnd = Frame.SnapshotEnd.TemplateId |
|
static |
A source's snapshot of one round: its digest, the bytes staying with each instance.
◆ SnapshotPolicyRegistered
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.SnapshotPolicyRegistered = Frame.SnapshotPolicyRegistered.TemplateId |
|
static |
The topology file's snapshot policy.
◆ SnapshotRequested
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.SnapshotRequested = Frame.SnapshotRequested.TemplateId |
|
static |
An operator asking for a snapshot round.
◆ SnapshotStarted
| const int Org.Limitless.Seqeron.Protocol.SystemFrame.SnapshotStarted = 30 |
|
static |
Synthesis-only; SnapshotStarted.TemplateId is the frame's, not this.
The documentation for this class was generated from the following file: