class DbAcsCommitmentStore extends AcsCommitmentStore with DbPrunableByTimeDomain[AcsCommitmentStoreError] with DbStore

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

Instance Constructors

  1. new DbAcsCommitmentStore(storage: DbStorage, domainId: IndexedDomain, protocolVersion: ProtocolVersion, cryptoApi: CryptoPureApi, 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, AcsCommitmentStoreError, 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(before: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, Unit]
    Definition Classes
    DbAcsCommitmentStorePrunableByTime
  12. val domainId: IndexedDomain
  13. implicit val ec: ExecutionContext
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def getComputed(period: CommitmentPeriod, counterParticipant: ParticipantId)(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, CommitmentType)]]

    Finds all stored computed commitments whose period overlaps with the given period.

    Finds all stored computed commitments whose period overlaps with the given period.

    No guarantees on the order of the returned commitments.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentLookup
  18. implicit val getSignedCommitment: GetResult[SignedProtocolMessage[AcsCommitment]]
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  21. 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
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. 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
  24. def lastComputedAndSent(implicit traceContext: TraceContext): Future[Option[CantonTimestampSecond]]

    Last locally processed timestamp.

    Last locally processed timestamp.

    Upon crash-recovery, it is safe to resubscribe to the sequencer starting after the returned timestamp.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentLookup
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbAcsCommitmentStoreNamedLogging
  27. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. def markComputedAndSent(period: CommitmentPeriod)(implicit traceContext: TraceContext): Future[Unit]

    Marks a period as processed and thus its end as a safe point for crash-recovery.

    Marks a period as processed and thus its end as a safe point for crash-recovery.

    To be called by the ACS commitment processor only.

    The period must be after the time point returned by lastComputedAndSent.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentStore
  29. def markOutstanding(period: CommitmentPeriod, counterParticipants: Set[ParticipantId])(implicit traceContext: TraceContext): Future[Unit]

    Mark that remote commitments are outstanding for a period

    Mark that remote commitments are outstanding for a period

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentStore
  30. def markSafe(counterParticipant: ParticipantId, period: CommitmentPeriod)(implicit traceContext: TraceContext): Future[Unit]

    Mark a period as safe for a counterparticipant.

    Mark a period as safe for a counterparticipant. To be called by the ACS commitment processor only.

    "Safe" here means that the received commitment matches the locally computed commitment. The toInclusive field of the period must not be higher than that of the last period passed to markComputedAndSent.

    May be called with the same parameters again, after a restart or a domain reconnect.

    Marking a period as safe may change the result of calling outstanding.

    TODO(#8207): Currently, the implementations may assume that all arguments this method is ever called with will have the same interval, as will the intervals in the arguments to storeReceived and storeComputed.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentStore
  31. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def noOutstandingCommitments(beforeOrAt: CantonTimestamp)(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    The latest timestamp before or at the given timestamp for which no commitments are outstanding.

    The latest timestamp before or at the given timestamp for which no commitments are outstanding. It is safe to prune the domain at the returned timestamp as long as it is not before the last timestamp needed for crash recovery (see com.digitalasset.canton.participant.pruning.AcsCommitmentProcessor.safeToPrune)

    Returns None if no such tick is known.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentLookup
  34. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. def onClosed(): Unit
    Definition Classes
    DbAcsCommitmentStoreFlagCloseable
  38. def outstanding(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId])(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, ParticipantId)]]

    Inspection: find periods for which commitments are still outstanding, and from whom.

    Inspection: find periods for which commitments are still outstanding, and from whom.

    The returned periods may overlap.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentLookup
  39. val partitionColumn: String
    Attributes
    protected[this]
    Definition Classes
    DbPrunableByTimeDomainDbPrunableByTime
  40. def partitionKey: IndexedDomain
    Attributes
    protected[this]
    Definition Classes
    DbPrunableByTimeDomainDbPrunableByTime
  41. 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
  42. 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
  43. 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
  44. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  45. 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
  46. val processingTime: GaugeM[TimedLoadGauge, Double]
    Attributes
    protected
    Definition Classes
    DbAcsCommitmentStoreDbPrunableByTime
  47. final def prune(limit: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, 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
  48. def pruningStatus(implicit traceContext: TraceContext): EitherT[Future, AcsCommitmentStoreError, 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
  49. val 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
    DbAcsCommitmentStoreDbPrunableByTime
  50. val queue: DbCommitmentQueue
  51. 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
  52. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  53. val runningCommitments: DbIncrementalCommitmentStore
  54. def searchComputedBetween(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId])(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, ParticipantId, CommitmentType)]]

    Inspection: search computed commitments applicable to the specified period (start/end are inclusive)

    Inspection: search computed commitments applicable to the specified period (start/end are inclusive)

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentLookup
  55. def searchReceivedBetween(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId])(implicit traceContext: TraceContext): Future[Iterable[SignedProtocolMessage[AcsCommitment]]]

    Inspection: search received commitments applicable to the specified period (start/end are inclusive)

    Inspection: search received commitments applicable to the specified period (start/end are inclusive)

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentLookup
  56. implicit val setParameterDiscriminator: SetParameter[IndexedDomain]
    Attributes
    protected[this]
    Definition Classes
    DbPrunableByTimeDomainDbPrunableByTime
  57. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbAcsCommitmentStoreDbStore
  58. def storeComputed(period: CommitmentPeriod, counterParticipant: ParticipantId, commitment: CommitmentType)(implicit traceContext: TraceContext): Future[Unit]

    Store a locally computed ACS commitment.

    Store a locally computed ACS commitment. To be called by the ACS commitment processor only.

    If the method is called twice with the same period and counter participant, then the supplied commitments must be the same too. Otherwise, the future fails.

    The implementation is guaranteed to be idempotent: calling it twice with the same argument doesn't change the system's behavior compared to calling it only once.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentStore
  59. def storeReceived(commitment: SignedProtocolMessage[AcsCommitment])(implicit traceContext: TraceContext): Future[Unit]

    Store a received ACS commitment.

    Store a received ACS commitment. To be called by the ACS commitment processor only.

    The implementation is guaranteed to be idempotent: calling it twice with the same argument doesn't change the store's behavior compared to calling it only once.

    The callers are free to insert multiple different commitments for the same commitment period; all of them will be stored (but will be deduplicated). This can be used in case the commitment sender is malicious or buggy, and sends both a correct and an incorrect commitment for the same time period. The caller can still store both commitments, for example, such that it can later prove to a third party that the sender sent an incorrect commitment.

    Definition Classes
    DbAcsCommitmentStoreAcsCommitmentStore
  60. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  61. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbAcsCommitmentStoreFlagCloseable
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  65. 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 NamedLogging

Inherited from FlagCloseable

Inherited from AcsCommitmentStore

Inherited from AutoCloseable

Inherited from AcsCommitmentLookup

Inherited from AnyRef

Inherited from Any

Ungrouped