seqeron 0.18.0
Loading...
Searching...
No Matches
Org.Limitless.Seqeron.App Namespace Reference

Classes

class  Application
 One replica of a co-located application — the kind of producer nothing elects. One runs per node, the topology's <applications> section names it, and LeadershipChanged already picks the replica that submits: this one publishes only while its own node leads. What that takes is behind it — the cluster session over the node's own aeron:ipc, the queue it follows, the leader gate, confirmed ingress across a failover, and the fences that say it may no longer act. More...
 
class  ApplicationOptions
 Everything one Application replica needs to join its deployment; the Java builder's setters, as properties. More...
 
class  Consumer
 A read-only client: it reads one group's queue and publishes nothing, so it opens no cluster session, takes no part in an election and needs no topology row. Audit, risk or a downstream feed. It replays local history through the co-located Replayer, switches to the live queue once caught up, and delivers every application message once, in clusterSeqNo order, as a Payload — the same view the producers' façades give. More...
 
class  ConsumerOptions
 Everything one Consumer needs to follow its queue; the Java builder's setters, as properties. More...
 
class  Gateway
 One instance of an elected active/standby producer pair. Everything this tier defines about being a gateway is behind it: the list row that names the instance, the designation that makes it serve, the GatewayStarted that binds its session, the connection id space it resumes from its predecessor, the connection lifecycle frames, confirmed ingress across a failover, and the fences that stand it down. More...
 
class  GatewayLifecycle
 The election lifecycle of one gateway instance: which instance of a logical gateway opens its gate, and when it stops. The gate is whatever the edge does to serve — an acceptor binds, an initiator dials.
 
class  GatewayOptions
 Everything one Gateway instance needs to join its pair; the Java builder's setters, as properties. More...
 
class  GroupDirectory
 The log's group table, as a producer addresses it (spec A-9): a group's name to its bit of groupMask, and a groupId to its name. Immutable: the groups are fixed by the first topology load (S-8), so one directory holds for the life of the archive. Combine masks with |. More...
 
class  GroupResolution
 The groups a producer addresses (spec A-9): the latest group table on its queue, or its snapshot header's when none follows the cut, resolved once when it has caught up, and the mask each frame it publishes then carries. Holds no Aeron runtime; Session drives it.
 
interface  IApplicationListener
 What an application does that Application cannot do for it. Only OnLeadershipChanged, OnSequenced and OnFenced must be implemented; the rest do nothing by default. More...
 
interface  IConsumerListener
 What a consumer does that Consumer cannot do for it. Only OnSequenced and OnFenced must be implemented; the rest do nothing by default. More...
 
interface  IGatewayListener
 What a gateway does that Gateway cannot do for it. Only OnActivated, OnStandby, OnSequenced and OnFenced must be implemented; the rest do nothing by default. More...
 
interface  ISnapshotListener
 What a source that takes part in snapshot rounds serializes, and restores from (doc/snapshot.md §4, §7). Given to a façade's options; a source whose topology row says snapshot="true" takes part only if it has one, and every instance of a source runs the same build, so either all of them do or none does. An instance given one restores its source's latest snapshot on start, if there is one. More...
 
class  LeaderGate
 Whether this replica may do leader-only work: caught up, and its node is the leader — or, off the cluster, caught up alone. Gives edges rather than a boolean, because OutstandingWork.OnNotLeader belongs on the closing edge.
 
class  OutstandingWork
 Leader-only request/reply work tracked across a failover. Every replica feeds it the same clusterSeqNo-ordered stream, so all replicas hold the same outstanding set.

  • Outstanding is replicated: a request is outstanding from its sequenced request (OnRequest) until its sequenced reply (OnReply).
  • Dispatched is local: "this node is handling it", cleared by OnNotLeader and OnReplyNotEmitted. Only the leader dispatches.
More...
 
class  Payload
 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...
 
class  QueueResolution
 Which queue this instance reads (spec R-6): a QueueRequest to the node's Replayer, resent until it answers with a QueueResolved. Until then the Replayer answers ReplayPending, which holds the resend off as it does a replay request's. Holds no Aeron runtime; Session is its transport.
 
class  QueueStallFence
 A producer's queue-liveness fence: no ClusterHeartbeat for a deadline, on an instance that has caught up. The heartbeat is the one frame that keeps arriving while every producer is silent, so its absence — and nothing else — separates a quiet deployment from a queue this process has stopped seeing.
 
class  RecoveryStallFence
 A gateway's recovery-stall fence: recovery dispatching nothing for a deadline, once this instance has been caught up at least once. It covers the state a queue-silence watchdog cannot, because that watchdog is gated on IsCaughtUp: a recovery that never converges would otherwise keep an active gateway serving behind a view of the log frozen at a hole it cannot close.
 
class  Session
 What every seqeron client does the same way: the cluster session it submits on, the co-located queue it follows, confirmed ingress across a failover, and the fences that say when it may no longer act — wired together into one DoWork whose ordering is not the caller's to get right.
 
class  SnapshotFrames
 The frame of a round a façade publishes, its SnapshotEnd (doc/snapshot.md §4), under its sourceId and belonging to no connection. SnapshotFrames.java and app/detail/SnapshotFrames.hpp are its twins; keep the three in step.
 
class  SnapshotOptions
 What takes a façade into snapshot rounds: the listener, and the directory where the instance keeps its snapshots, one file per round. The directory is the instance's own (no other instance, its pair's included, may write it), and a restart restores from what it holds, so it must outlive the process. More...
 
class  SnapshotTaker
 A façade's side of snapshot rounds, with no Aeron in it (doc/snapshot.md §4): serialize at the cut into this instance's own file, submit the round's SnapshotEnd if this instance may publish, and compare the source's sequenced SnapshotEnd with what this instance serialized (A-7). The façade feeds it the frames and drives Submit from its duty cycle; every outcome is the façade's to act on.
 
class  Tuning
 The policy knobs a producer rarely changes, kept off its options so that holds only identity and wiring. More...
 

Enumerations

enum  ClusterError {
  ClusterSessionLost , IngressConfirmFaulted , RecoveryStalled , QueueStalled ,
  SnapshotDiverged , SnapshotUnrestorable , GroupUnknown , ClientProtocol
}
 Why a producer may no longer act. Each is terminal and latched: the façade releases its cluster session so a standby can take over, rather than carrying on behind a view of the log it cannot trust. More...
 

Functions

readonly record struct ReplyAddress (int SourceId, int ConnectionId, ushort GroupMask)
 What a reply needs of the request it answers: the requester's sourceId, connectionId and groupMask. Unlike the Payload it came from, it outlives the callback, so keep it for a reply dispatched later.
 

Enumeration Type Documentation

◆ ClusterError

Why a producer may no longer act. Each is terminal and latched: the façade releases its cluster session so a standby can take over, rather than carrying on behind a view of the log it cannot trust.

Enumerator
ClusterSessionLost 

The cluster closed this session, or a new leader never arrived, on a gateway instance that had announced its activation on it; or no new session replaced it in time on any other. This instance can never be promoted again.

IngressConfirmFaulted 

An own frame came back differing from the oldest pending one, so what reached the log cannot be counted.

RecoveryStalled 

Recovery has dispatched nothing for the deadline, on an instance that had caught up before; only a designated gateway instance or the leader's replica fences, any other logs it.

QueueStalled 

No ClusterHeartbeat for the deadline: this process has stopped seeing its node's queue. Fences as RecoveryStalled does.

SnapshotDiverged 

This instance's snapshot of a round differs from its source's sequenced one: its state is not the log's (A-7).

SnapshotUnrestorable 

This instance has a snapshot it cannot restore: a format or header version this build does not read, or a file whose records fail the SnapshotEnd the log holds for them.

GroupUnknown 

A group this instance addresses is not in the log's group table (A-9).

ClientProtocol 

A hosted client broke the host protocol, for instance by opening a connection under an id the façade did not allocate.

Function Documentation

◆ ReplyAddress()

readonly record struct Org.Limitless.Seqeron.App.ReplyAddress ( int  SourceId,
int  ConnectionId,
ushort  GroupMask 
)

What a reply needs of the request it answers: the requester's sourceId, connectionId and groupMask. Unlike the Payload it came from, it outlives the callback, so keep it for a reply dispatched later.