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

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...

Inheritance diagram for Org.Limitless.Seqeron.App.Consumer:
Collaboration diagram for Org.Limitless.Seqeron.App.Consumer:

Public Member Functions

 Consumer (ConsumerOptions options)
 A consumer configured by options ; nothing is connected until Start.
 
void Start (Aeron aeron)
 Starts following the group's queue on this node; the Aeron client is the caller's.
 
int DoWork ()
 One duty-cycle iteration. Nothing once fenced.
 
void Dispose ()
 Closes the queue and replay subscriptions. The Aeron client is the caller's and is left open.
 

Properties

bool IsCaughtUp [get]
 
long LastClusterSeqNo [get]
 

Detailed Description

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.

Fenced, like them, when it can no longer be trusted to see the queue: ClusterError.RecoveryStalled and ClusterError.QueueStalled. It takes no snapshots and so always restarts from the start of its queue, which a cluster with a <snapshots> policy no longer holds; a consumer there is an Application or Gateway with a snapshot listener that writes no records.

Single-threaded: every member belongs to the caller's one duty-cycle thread, which calls DoWork each iteration. Consumer.java and app/Consumer.hpp are its twins; keep the three in step. ReplayerStreamReceiver is the lower-level path this sits on.

Constructor & Destructor Documentation

◆ Consumer()

Org.Limitless.Seqeron.App.Consumer.Consumer ( ConsumerOptions  options)
inline

A consumer configured by options ; nothing is connected until Start.

Exceptions
ArgumentExceptionif a required option is missing

Member Function Documentation

◆ Dispose()

void Org.Limitless.Seqeron.App.Consumer.Dispose ( )
inline

Closes the queue and replay subscriptions. The Aeron client is the caller's and is left open.

◆ DoWork()

int Org.Limitless.Seqeron.App.Consumer.DoWork ( )
inline

One duty-cycle iteration. Nothing once fenced.

Returns
units of work done, for the caller's idle strategy

◆ Start()

void Org.Limitless.Seqeron.App.Consumer.Start ( Aeron  aeron)
inline

Starts following the group's queue on this node; the Aeron client is the caller's.

Property Documentation

◆ IsCaughtUp

bool Org.Limitless.Seqeron.App.Consumer.IsCaughtUp
get

◆ LastClusterSeqNo

long Org.Limitless.Seqeron.App.Consumer.LastClusterSeqNo
get

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