abstract class TopologyStoreX[+StoreID <: TopologyStoreId] extends AutoCloseable with TopologyStoreCommon[StoreID, GenericValidatedTopologyTransactionX, GenericStoredTopologyTransactionX, GenericSignedTopologyTransactionX]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologyStoreX
  2. TopologyStoreCommon
  3. FlagCloseable
  4. PerformUnlessClosing
  5. OnShutdownRunner
  6. AutoCloseable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TopologyStoreX()(implicit ec: ExecutionContext)

Abstract Value Members

  1. abstract def bootstrap(snapshot: GenericStoredTopologyTransactionsX)(implicit traceContext: TraceContext): Future[Unit]

    store an initial set of topology transactions as given into the store

  2. abstract def currentDispatchingWatermark(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    returns the current dispatching watermark

    returns the current dispatching watermark

    for topology transaction dispatching, we keep track up to which point in time we have mirrored the authorized store to the remote store

    the timestamp always refers to the timestamp of the authorized store!

    Definition Classes
    TopologyStoreCommon
  3. abstract def dumpStoreContent()(implicit traceContext: TraceContext): Unit
  4. abstract def findDispatchingTransactionsAfter(timestampExclusive: CantonTimestamp, limit: Option[Int])(implicit traceContext: TraceContext): Future[GenericStoredTopologyTransactionsX]
  5. abstract def findEssentialStateForMember(member: Member, asOfInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[GenericStoredTopologyTransactionsX]
  6. abstract def findFirstMediatorStateForMediator(mediatorId: MediatorId)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransactionX[Replace, MediatorDomainStateX]]]
  7. abstract def findFirstTrustCertificateForParticipant(participant: ParticipantId)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransactionX[Replace, DomainTrustCertificateX]]]
  8. abstract def findParticipantOnboardingTransactions(participantId: ParticipantId, domainId: DomainId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[GenericSignedTopologyTransactionX]]

    returns initial set of onboarding transactions that should be dispatched to the domain

  9. abstract def findPositiveTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, isProposal: Boolean, types: Seq[Code], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactionsX]

    returns the set of positive transactions

    returns the set of positive transactions

    this function is used by the topology processor to determine the set of transaction, such that we can perform cascading updates if there was a certificate revocation

    asOfInclusive

    whether the search interval should include the current timepoint or not. the state at t is defined as "exclusive" of t, whereas for updating the state, we need to be able to query inclusive.

  10. abstract def findProposalsByTxHash(asOfExclusive: EffectiveTime, hashes: NonEmpty[Set[TxHash]])(implicit traceContext: TraceContext): Future[Seq[GenericSignedTopologyTransactionX]]
  11. abstract def findStored(transaction: GenericSignedTopologyTransactionX, includeRejected: Boolean = false)(implicit traceContext: TraceContext): Future[Option[GenericStoredTopologyTransactionX]]
    Definition Classes
    TopologyStoreCommon
  12. abstract def findStoredForVersion(transaction: GenericTopologyTransactionX, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): Future[Option[GenericStoredTopologyTransactionX]]
  13. abstract def findTransactionsByTxHash(asOfExclusive: EffectiveTime, hashes: NonEmpty[Set[TxHash]])(implicit traceContext: TraceContext): Future[Seq[GenericSignedTopologyTransactionX]]
  14. abstract def findTransactionsForMapping(asOfExclusive: EffectiveTime, hashes: NonEmpty[Set[MappingHash]])(implicit traceContext: TraceContext): Future[Seq[GenericSignedTopologyTransactionX]]
  15. abstract def findUpcomingEffectiveChanges(asOfInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[Change]]

    fetch the effective time updates greater than or equal to a certain timestamp

    fetch the effective time updates greater than or equal to a certain timestamp

    this function is used to recover the future effective timestamp such that we can reschedule "pokes" of the topology client and updates of the acs commitment processor on startup

    Definition Classes
    TopologyStoreCommon
  16. abstract def inspect(proposals: Boolean, timeQuery: TimeQueryX, recentTimestampO: Option[CantonTimestamp], op: Option[TopologyChangeOpX], typ: Option[Code], idFilter: String, namespaceOnly: Boolean)(implicit traceContext: TraceContext): Future[StoredTopologyTransactionsX[TopologyChangeOpX, TopologyMappingX]]

    query optimized for inspection

    query optimized for inspection

    proposals

    if true, query only for proposals instead of approved transaction mappings

    recentTimestampO

    if exists, use this timestamp for the head state to prevent race conditions on the console

  17. abstract def inspectKnownParties(timestamp: CantonTimestamp, filterParty: String, filterParticipant: String, limit: Int)(implicit traceContext: TraceContext): Future[Set[PartyId]]
  18. abstract def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
  19. abstract def maxTimestamp()(implicit traceContext: TraceContext): Future[Option[(SequencedTime, EffectiveTime)]]
    Definition Classes
    TopologyStoreCommon
  20. abstract def storeId: StoreID
    Definition Classes
    TopologyStoreCommon
  21. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable
  22. abstract def update(sequenced: SequencedTime, effective: EffectiveTime, removeMapping: Set[MappingHash], removeTxs: Set[TxHash], additions: Seq[GenericValidatedTopologyTransactionX])(implicit traceContext: TraceContext): Future[Unit]

    add validated topology transaction as is to the topology transaction table

  23. abstract def updateDispatchingWatermark(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    update the dispatching watermark for this target store

    update the dispatching watermark for this target store

    Definition Classes
    TopologyStoreCommon

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 cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. 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 → OnShutdownRunner → AutoCloseable
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable → PerformUnlessClosing
  9. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  10. implicit val ec: ExecutionContext
    Definition Classes
    TopologyStoreX → TopologyStoreCommon
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def exists(transaction: GenericSignedTopologyTransactionX)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    TopologyStoreCommon
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  17. 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
    OnShutdownRunner
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
    PerformUnlessClosing
  20. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  25. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  26. final def onFirstClose(): 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
    PerformUnlessClosing → OnShutdownRunner
    Annotations
    @SuppressWarnings()
  27. 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
    PerformUnlessClosing
  28. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    PerformUnlessClosing
  29. 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
    PerformUnlessClosing
  30. 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
    PerformUnlessClosing
  31. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  32. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  33. 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
    PerformUnlessClosing
  34. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  35. def providesAdditionalSignatures(transaction: GenericSignedTopologyTransactionX)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    TopologyStoreX → TopologyStoreCommon
  36. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  37. def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    OnShutdownRunner
  38. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  39. def signedTxFromStoredTx(storedTx: GenericStoredTopologyTransactionX): SignedTopologyTransactionX[TopologyChangeOpX, TopologyMappingX]
    Attributes
    protected
    Definition Classes
    TopologyStoreX → TopologyStoreCommon
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. 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

Ungrouped