Packages

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
DbSequencerStateManagerStore, InMemorySequencerStateManagerStore
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SequencerStateManagerStore
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

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

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

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

  5. 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 None if all events can be read.

  6. abstract def getInitialTopologySnapshotTimestamp(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    Retrieve the timestamp of the initial topology snapshot if available.

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

  8. 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()
  9. abstract def numberOfEvents()(implicit traceContext: TraceContext): Future[Long]
    Attributes
    protected[state]
    Annotations
    @VisibleForTesting()
  10. abstract def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[PruningResult]
  11. 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

  12. 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.IllegalArgumentException if startInclusive is not less than endExclusive

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

  14. abstract def status()(implicit traceContext: TraceContext): Future[InternalSequencerPruningStatus]

    Build a status object representing the current state of the sequencer.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped