com.digitalasset.canton.domain.sequencing.integrations.state
SequencerStateManagerStore
Companion object SequencerStateManagerStore
trait SequencerStateManagerStore extends AnyRef
Backing store for the com.digitalasset.canton.domain.block.BlockSequencerStateManager used for sequencer integrations to persist some sequencer data into a database.
- Alphabetic
- By Inheritance
- SequencerStateManagerStore
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def acknowledge(member: Member, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
Write an acknowledgement that member has processed earlier timestamps.
Write an acknowledgement that member has processed earlier timestamps. Only the latest timestamp needs to be stored. Earlier timestamps can be overwritten. Acknowledgements of earlier timestamps should be ignored.
- abstract def addEvents(events: Map[Member, OrdinarySerializedEvent], trafficSate: Map[Member, TrafficState])(implicit traceContext: TraceContext): Future[Unit]
Add a new events to the sequencer store.
Add a new events to the sequencer store. Callers must ensure that all members receiving a counter update have been registered and that the counter values are correct. Callers must also ensure that the timestamp is correct and later than all prior events as this is also not validated by all store implementations. Counter updates for invalid counter values (<0) will cause a java.lang.IllegalArgumentException to be throw. Implementations may throw a java.lang.IllegalArgumentException if a counter update is incorrect (not following the current head), but may not if this is not possible to efficiently do (like with database persistence that would require executing a query to check). Implementations should ensure that all events are written atomically (or none written if a failure is hit).
- abstract def addInFlightAggregationUpdates(updates: InFlightAggregationUpdates)(implicit traceContext: TraceContext): Future[Unit]
Updates the in-flight aggregations for the given aggregation IDs.
Updates the in-flight aggregations for the given aggregation IDs. Only adds or updates aggregations, but never removes them.
- See also
expireInFlightAggregations for removing in-flight aggregations
- abstract def addMember(member: Member, addedAt: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
Adds a new member to the sequencer.
Adds a new member to the sequencer. Callers are expected to ensure that the member is not already registered.
- abstract def disableMember(member: Member)(implicit traceContext: TraceContext): Future[Unit]
Prevents member from sending and reading from the sequencer, and allows unread data for this member to be pruned.
Prevents member from sending and reading from the sequencer, and allows unread data for this member to be pruned. It however won't stop any sends addressed to this member.
- abstract def fetchLowerBound()(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]
Fetch the lower bound of events that can be read.
Fetch the lower bound of events that can be read. Returns
Noneif all events can be read. - abstract def getInitialTopologySnapshotTimestamp(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]
Retrieve the timestamp of the initial topology snapshot if available.
- abstract def isEnabled(member: Member)(implicit traceContext: TraceContext): Future[Boolean]
Check whether the member is enabled.
Check whether the member is enabled. Currently used when receiving a request for reading.
- abstract def latestAcknowledgements()(implicit traceContext: TraceContext): Future[Map[Member, CantonTimestamp]]
Return the latest acknowledgements for all members
Return the latest acknowledgements for all members
- Attributes
- protected[state]
- Annotations
- @VisibleForTesting()
- abstract def numberOfEvents()(implicit traceContext: TraceContext): Future[Long]
- Attributes
- protected[state]
- Annotations
- @VisibleForTesting()
- abstract def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[PruningResult]
- abstract def pruneExpiredInFlightAggregations(upToInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
Removes all in-flight aggregations that have expired before or at the given timestamp
- abstract def readAtBlockTimestamp(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[EphemeralState]
Rehydrate the sequencer EphemeralState from the backing persisted store
Rehydrate the sequencer EphemeralState from the backing persisted store
- timestamp
The timestamp for which the EphemeralState is computed
- abstract def readRange(member: Member, startInclusive: SequencerCounter, endExclusive: SequencerCounter)(implicit traceContext: TraceContext): Source[OrdinarySerializedEvent, NotUsed]
Extract a range of events for a member.
Extract a range of events for a member. It is expected that the sequencer will validate requests against its current state so read requests for unregistered members or counter ranges that do not exist should just return an empty source.
- Exceptions thrown
java.lang.IllegalArgumentExceptionif startInclusive is not less than endExclusive
- abstract def saveLowerBound(ts: CantonTimestamp, maybeOnboardingTopologyTimestamp: Option[CantonTimestamp] = None)(implicit traceContext: TraceContext): EitherT[Future, SaveLowerBoundError, Unit]
Save an updated lower bound of events that can be read along with the optional timestamp of the initial onboarding topology snapshot.
Save an updated lower bound of events that can be read along with the optional timestamp of the initial onboarding topology snapshot.
The lower bound of events ts must be equal or greater than any prior set lower bound. The value of maybeOnboardingTopologyTimestamp is only set if nonEmpty and only on the initial call.
- abstract def status()(implicit traceContext: TraceContext): Future[InternalSequencerPruningStatus]
Build a status object representing the current state of the sequencer.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])