class DbSequencerStateManagerStore extends SequencerStateManagerStore with NamedLogging
Database store for server side sequencer data. If you need more than one sequencer running on the same db, you can isolate them using different sequencerStoreIds. This is useful for tests and for sequencer applications that implement multiple domains.
- Alphabetic
- By Inheritance
- DbSequencerStateManagerStore
- NamedLogging
- SequencerStateManagerStore
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbSequencerStateManagerStore(storage: DbStorage, loggerFactory: NamedLoggerFactory, maxBatchSize: Int = 1000)(implicit ec: ExecutionContext)
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
- 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.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def acknowledgeDBIO(member: Member, timestamp: CantonTimestamp): All[Unit]
- def addEvents(events: Map[Member, OrdinarySerializedEvent])(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).
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def addEventsDBIO(events: Map[Member, OrdinarySerializedEvent])(implicit batchTraceContext: TraceContext): All[Unit]
- 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.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def addMemberDBIO(member: Member, addedAt: CantonTimestamp)(implicit traceContext: TraceContext): All[Unit]
- 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()
- 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.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def disableMemberDBIO(member: Member): WriteOnly[Unit]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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]
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbSequencerStateManagerStore → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def numberOfEvents()(implicit traceContext: TraceContext): Future[Long]
- Attributes
- protected[state]
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[PruningResult]
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def readAtTimestamp(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[EphemeralState]
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def readAtTimestampDBIO(timestamp: Option[CantonTimestamp]): resource.DbStorage.Profile.DbStorageAPI.DBIOAction[EphemeralState, resource.DbStorage.Profile.DbStorageAPI.NoStream, Read with Transactional]
If timestamp provided, it will compute the state up until (inclusive) that timestamp.
If timestamp provided, it will compute the state up until (inclusive) that timestamp. If none provided, it will compute the state at current head.
- def readHead(implicit traceContext: TraceContext): Future[EphemeralState]
Rehydrate the sequencer EphemeralState from the backing persisted store
Rehydrate the sequencer EphemeralState from the backing persisted store
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- 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.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- Exceptions thrown
java.lang.IllegalArgumentExceptionif startInclusive is not less than endExclusive
- def saveLowerBound(ts: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, SaveLowerBoundError, Unit]
Save an updated lower bound of events that can be read.
Save an updated lower bound of events that can be read. Must be equal or greater than any prior set lower bound.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- def saveLowerBoundDBIO(ts: CantonTimestamp): All[Either[SaveLowerBoundError, Unit]]
- def status(now: CantonTimestamp)(implicit traceContext: TraceContext): Future[SequencerPruningStatus]
Build a status object representing the current state of the sequencer.
Build a status object representing the current state of the sequencer.
- Definition Classes
- DbSequencerStateManagerStore → SequencerStateManagerStore
- val storage: DbStorage
- 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])