c

com.digitalasset.canton.participant.store.memory

InMemoryAcsCommitmentStore

class InMemoryAcsCommitmentStore extends AcsCommitmentStore with InMemoryPrunableByTime with NamedLogging

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InMemoryAcsCommitmentStore
  2. NamedLogging
  3. InMemoryPrunableByTime
  4. AcsCommitmentStore
  5. AutoCloseable
  6. PrunableByTime
  7. AcsCommitmentLookup
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new InMemoryAcsCommitmentStore(loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

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. def advancePruningTimestamp(phase: PruningPhase, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
    Attributes
    protected[canton]
    Definition Classes
    InMemoryPrunableByTimePrunableByTime
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def batchingParameters: Option[PrunableByTimeParameters]

    Parameters to control prune batching

    Parameters to control prune batching

    If defined, then the pruning window will be computed such that it targets the ideal target batch size in order to optimize the load on the database.

    This is currently used with the journal stores. Normal pruning of other stores already does batching on its own.

    Attributes
    protected
    Definition Classes
    PrunableByTime
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def close(): Unit
    Definition Classes
    InMemoryAcsCommitmentStore → AutoCloseable
  9. def doPrune(before: CantonTimestamp, lastPruning: Option[CantonTimestamp])(implicit traceContext: TraceContext): Future[Int]

    Actual invocation of doPrune

    Actual invocation of doPrune

    returns

    the approximate number of pruned rows, used to adjust the pruning windows to reach optimal batch sizes

    Definition Classes
    InMemoryAcsCommitmentStorePrunableByTime
  10. implicit val ec: ExecutionContext
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. def getComputed(period: CommitmentPeriod, counterParticipant: ParticipantId)(implicit traceContext: TraceContext): Future[List[(CommitmentPeriod, CommitmentType)]]

    Finds for a counter participant all stored computed commitments whose period overlaps with the given period.

    Finds for a counter participant all stored computed commitments whose period overlaps with the given period.

    No guarantees on the order of the returned commitments.

    Definition Classes
    InMemoryAcsCommitmentStoreAcsCommitmentLookup
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def kind: String
    Attributes
    protected
    Definition Classes
    AcsCommitmentStorePrunableByTime
  19. 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
    InMemoryAcsCommitmentStoreAcsCommitmentLookup
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    InMemoryAcsCommitmentStoreNamedLogging
  22. 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
    InMemoryAcsCommitmentStoreAcsCommitmentStore
  23. 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
    InMemoryAcsCommitmentStoreAcsCommitmentStore
  24. def markSafe(counterParticipant: ParticipantId, period: CommitmentPeriod, sortedReconciliationIntervalsProvider: SortedReconciliationIntervalsProvider)(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.

    Definition Classes
    InMemoryAcsCommitmentStoreAcsCommitmentStore
  25. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. 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
    InMemoryAcsCommitmentStoreAcsCommitmentLookup
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. 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
    InMemoryAcsCommitmentStoreAcsCommitmentLookup
  32. final def prune(limit: CantonTimestamp)(implicit errorLoggingContext: ErrorLoggingContext, closeContext: CloseContext): Future[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
  33. def pruningStatus(implicit traceContext: TraceContext): Future[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
    InMemoryPrunableByTimePrunableByTime
  34. val pruningStatusF: AtomicReference[Option[PruningStatus]]
    Attributes
    protected[this]
    Definition Classes
    InMemoryPrunableByTime
  35. val queue: CommitmentQueue
  36. val runningCommitments: IncrementalCommitmentStore
  37. def searchComputedBetween(start: CantonTimestamp, end: CantonTimestamp, counterParticipant: Option[ParticipantId] = None)(implicit traceContext: TraceContext): Future[Iterable[(CommitmentPeriod, ParticipantId, CommitmentType)]]

    Inspection: search computed commitments applicable to the specified period (start is exclusive, end is inclusive)

    Inspection: search computed commitments applicable to the specified period (start is exclusive, end is inclusive)

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

    Inspection: search received commitments applicable to the specified period (start is exclusive, end is inclusive)

    Inspection: search received commitments applicable to the specified period (start is exclusive, end is inclusive)

    Definition Classes
    InMemoryAcsCommitmentStoreAcsCommitmentLookup
  39. 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
    InMemoryAcsCommitmentStoreAcsCommitmentStore
  40. 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
    InMemoryAcsCommitmentStoreAcsCommitmentStore
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. 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 NamedLogging

Inherited from InMemoryPrunableByTime

Inherited from AcsCommitmentStore

Inherited from AutoCloseable

Inherited from PrunableByTime

Inherited from AcsCommitmentLookup

Inherited from AnyRef

Inherited from Any

Ungrouped