class DbSequencedEventStore extends SequencedEventStore with DbStore with DbPrunableByTime[SequencerClientDiscriminator, Nothing]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbSequencedEventStore
  2. DbPrunableByTime
  3. DbStore
  4. HasCloseContext
  5. FlagCloseable
  6. SequencedEventStore
  7. AutoCloseable
  8. NamedLogging
  9. PrunableByTime
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbSequencedEventStore(storage: DbStorage, client: SequencerClientDiscriminator, protocolVersion: ProtocolVersion, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def advancePruningTimestamp(phase: PruningPhase, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, Nothing, Unit]
    Attributes
    protected[canton]
    Definition Classes
    DbPrunableByTimePrunableByTime
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def close(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    FlagCloseable → AutoCloseable
    Annotations
    @SuppressWarnings()
  9. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  11. def doPrune(beforeAndIncluding: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, Nothing, Unit]
    Attributes
    protected[canton]
    Definition Classes
    DbSequencedEventStorePrunableByTime
  12. implicit val ec: ExecutionContext
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def find(criterion: SearchCriterion)(implicit traceContext: TraceContext): EitherT[Future, SequencedEventNotFoundError, PossiblyIgnoredSerializedEvent]

    Looks up an event by the given criterion.

    Looks up an event by the given criterion.

    returns

    SequencedEventNotFoundError if no stored event meets the criterion.

    Definition Classes
    DbSequencedEventStoreSequencedEventStore
  16. def findRange(criterion: RangeCriterion, limit: Option[Int])(implicit traceContext: TraceContext): EitherT[Future, SequencedEventRangeOverlapsWithPruning, Seq[PossiblyIgnoredSerializedEvent]]

    Looks up a set of sequenced events within the given range.

    Looks up a set of sequenced events within the given range.

    limit

    The maximum number of elements in the returned iterable, if set.

    Definition Classes
    DbSequencedEventStoreSequencedEventStore
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. implicit val getResultPossiblyIgnoredSequencedEvent: GetResult[PossiblyIgnoredSerializedEvent]
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def ignoreEvents(from: SequencerCounter, to: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, ChangeWouldResultInGap, Unit]

    Marks events between from and to as ignored.

    Marks events between from and to as ignored. Fills any gap between from and to by empty ignored events, i.e. ignored events without any underlying real event.

    returns

    ChangeWouldResultInGap if there would be a gap between the highest sequencer counter in the store and from.

    Definition Classes
    DbSequencedEventStoreSequencedEventStore
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  22. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    FlagCloseable
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    FlagCloseable
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbSequencedEventStoreNamedLogging
  27. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  34. def partitionColumn: String
    Attributes
    protected[this]
    Definition Classes
    DbSequencedEventStoreDbPrunableByTime
  35. val partitionKey: SequencerClientDiscriminator
    Attributes
    protected[this]
    Definition Classes
    DbSequencedEventStoreDbPrunableByTime
  36. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    FlagCloseable
  37. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  38. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  39. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  40. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    FlagCloseable
  41. val processingTime: GaugeM[TimedLoadGauge, Double]
    Attributes
    protected
    Definition Classes
    DbSequencedEventStoreDbPrunableByTime
  42. final def prune(limit: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, Nothing, Unit]

    Prune all unnecessary data relating to events before the given timestamp.

    Prune all unnecessary data relating to events before the given timestamp.

    The meaning of "unnecessary", and whether the limit is inclusive or exclusive both depend on the particular store. The store must implement the actual pruning logic in the doPrune method.

    Definition Classes
    PrunableByTime
  43. def pruningStatus(implicit traceContext: TraceContext): EitherT[Future, Nothing, Option[PruningStatus]]

    Returns the latest timestamp at which pruning was started or completed.

    Returns the latest timestamp at which pruning was started or completed. For com.digitalasset.canton.pruning.PruningPhase.Started, it is guaranteed that no pruning has been run on the store after the returned timestamp. For com.digitalasset.canton.pruning.PruningPhase.Completed, it is guaranteed that the store is pruned at least up to the returned timestamp (inclusive). That is, another pruning with the returned timestamp (or earlier) has no effect on the store. Returns scala.None$ if no pruning has ever been started on the store.

    Definition Classes
    DbPrunableByTimePrunableByTime
  44. def pruning_status_table: String

    The table name to store the pruning timestamp in.

    The table name to store the pruning timestamp in. The table must define the following fields:

    Attributes
    protected[this]
    Definition Classes
    DbSequencedEventStoreDbPrunableByTime
  45. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Definition Classes
    FlagCloseable
  46. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  47. def sequencedEvents(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[PossiblyIgnoredSerializedEvent]]
  48. implicit def setParameterDiscriminator: SetParameter[SequencerClientDiscriminator]
    Attributes
    protected[this]
    Definition Classes
    DbSequencedEventStoreDbPrunableByTime
  49. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbSequencedEventStoreDbStore
  50. def store(events: Seq[OrdinarySerializedEvent])(implicit traceContext: TraceContext): Future[Unit]

    Stores the given com.digitalasset.canton.sequencing.protocol.SequencedEvents.

    Stores the given com.digitalasset.canton.sequencing.protocol.SequencedEvents. If an event with the same timestamp already exist, the event may remain unchanged or overwritten.

    Definition Classes
    DbSequencedEventStoreSequencedEventStore
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbSequencedEventStoreFlagCloseable
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. def unignoreEvents(from: SequencerCounter, to: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, ChangeWouldResultInGap, Unit]

    Removes the ignored status from all events between from and to.

    Removes the ignored status from all events between from and to.

    returns

    ChangeWouldResultInGap if deleting empty ignored events between from and to would result in a gap in sequencer counters.

    Definition Classes
    DbSequencedEventStoreSequencedEventStore
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. 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

Inherited from DbStore

Inherited from HasCloseContext

Inherited from FlagCloseable

Inherited from SequencedEventStore

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from PrunableByTime[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped