class InMemoryTopologyStore[+StoreId <: TopologyStoreId] extends TopologyStore[StoreId] with InMemoryTopologyStoreCommon[StoreId] with NamedLogging
- Alphabetic
- By Inheritance
- InMemoryTopologyStore
- InMemoryTopologyStoreCommon
- NamedLogging
- TopologyStore
- TopologyStoreCommon
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new InMemoryTopologyStore(storeId: StoreId, loggerFactory: NamedLoggerFactory, timeouts: ProcessingTimeout, futureSupervisor: FutureSupervisor)(implicit ec: ExecutionContext)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allTransactions(includeRejected: Boolean = false)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def append(sequenced: SequencedTime, effective: EffectiveTime, transactions: Seq[ValidatedTopologyTransaction])(implicit traceContext: TraceContext): Future[Unit]
add validated topology transaction as is to the topology transaction table
add validated topology transaction as is to the topology transaction table
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bootstrap(collection: StoredTopologyTransactions[Positive])(implicit traceContext: TraceContext): Future[Unit]
Bootstrap a node state from a topology transaction collection
Bootstrap a node state from a topology transaction collection
- Definition Classes
- TopologyStore
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- 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
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- def currentDispatchingWatermark(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]
- Definition Classes
- InMemoryTopologyStoreCommon
- Annotations
- @nowarn()
- implicit val ec: ExecutionContext
- Definition Classes
- InMemoryTopologyStore → TopologyStoreCommon
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def exists(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- TopologyStoreCommon
- def findDispatchingTransactionsAfter(timestampExclusive: CantonTimestamp, limit: Option[Int])(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
returns transactions that should be dispatched to the domain
returns transactions that should be dispatched to the domain
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findInitialState(id: DomainTopologyManagerId)(implicit traceContext: TraceContext): Future[Map[KeyOwner, Seq[PublicKey]]]
query interface used by DomainTopologyManager to find the set of initial keys
query interface used by DomainTopologyManager to find the set of initial keys
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findParticipantOnboardingTransactions(participantId: ParticipantId, domainId: DomainId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[SignedTopologyTransaction[TopologyChangeOp]]]
returns initial set of onboarding transactions that should be dispatched to the domain
returns initial set of onboarding transactions that should be dispatched to the domain
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findPositiveTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, includeSecondary: Boolean, types: Seq[DomainTopologyTransactionType], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactions]
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.
- includeSecondary
some topology transactions have an "secondary" uid. currently, this only applies to the party to participant mapping where the secondary uid is the participant uid. we need this information during cascading updates of participant certificates.
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findPositiveTransactionsForMapping(mapping: TopologyMapping)(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Positive]]]
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findRemovalTransactionForMappings(mappings: Set[TopologyStateElement[TopologyMapping]])(implicit traceContext: TraceContext): Future[Seq[SignedTopologyTransaction[Remove]]]
finds transactions in the local store that would remove the topology state elements
finds transactions in the local store that would remove the topology state elements
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findStateTransactions(asOf: CantonTimestamp, asOfInclusive: Boolean, includeSecondary: Boolean, types: Seq[DomainTopologyTransactionType], filterUid: Option[Seq[UniqueIdentifier]], filterNamespace: Option[Seq[Namespace]])(implicit traceContext: TraceContext): Future[PositiveStoredTopologyTransactions]
query interface used by com.digitalasset.canton.topology.client.StoreBasedTopologySnapshot
query interface used by com.digitalasset.canton.topology.client.StoreBasedTopologySnapshot
- 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.
- includeSecondary
some topology transactions have an "secondary" uid. currently, this only applies to the party to participant mapping where the secondary uid is the participant uid. we need this information during cascading updates of participant certificates.
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findStored(transaction: SignedTopologyTransaction[TopologyChangeOp], includeRejected: Boolean = false)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
- Definition Classes
- InMemoryTopologyStore → TopologyStoreCommon
- def findStoredForVersion(transaction: TopologyTransaction[TopologyChangeOp], protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): Future[Option[StoredTopologyTransaction[TopologyChangeOp]]]
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findStoredNoSignature(transaction: TopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Seq[StoredTopologyTransaction[TopologyChangeOp]]]
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findTransactionsInRange(asOfExclusive: CantonTimestamp, upToExclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
Returns an ordered list of transactions from the transaction store within a certain range
Returns an ordered list of transactions from the transaction store within a certain range
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def findTsOfParticipantStateChangesBefore(beforeExclusive: CantonTimestamp, participantId: ParticipantId, limit: Int)(implicit traceContext: TraceContext): Future[Seq[CantonTimestamp]]
returns an descending ordered list of timestamps of when participant state changes occurred before a certain point in time
returns an descending ordered list of timestamps of when participant state changes occurred before a certain point in time
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- 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
- InMemoryTopologyStore → TopologyStoreCommon
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def headTransactions(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[Positive]]
set of topology transactions which are active
set of topology transactions which are active
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def inspect(stateStore: Boolean, timeQuery: TimeQuery, recentTimestampO: Option[CantonTimestamp], ops: Option[TopologyChangeOp], typ: Option[DomainTopologyTransactionType], idFilter: String, namespaceOnly: Boolean)(implicit traceContext: TraceContext): Future[StoredTopologyTransactions[TopologyChangeOp]]
query optimized for inspection
query optimized for inspection
- recentTimestampO
if exists, use this timestamp for the head state to prevent race conditions on the console
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def inspectKnownParties(timestamp: CantonTimestamp, filterParty: String, filterParticipant: String, limit: Int)(implicit traceContext: TraceContext): Future[Set[PartyId]]
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- InMemoryTopologyStore → NamedLogging
- 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
- def maxTimestamp()(implicit traceContext: TraceContext): Future[Option[(SequencedTime, EffectiveTime)]]
- Definition Classes
- TopologyStore → TopologyStoreCommon
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Definition Classes
- InMemoryTopologyStore → PerformUnlessClosing
- 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()
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- 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
- 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
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, 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.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def providesAdditionalSignatures(transaction: SignedTopologyTransaction[TopologyChangeOp])(implicit traceContext: TraceContext): Future[Boolean]
- Definition Classes
- TopologyStore → TopologyStoreCommon
- 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
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- def signedTxFromStoredTx(storedTx: StoredTopologyTransaction[TopologyChangeOp]): SignedTopologyTransaction[TopologyChangeOp]
- Attributes
- protected
- Definition Classes
- TopologyStore → TopologyStoreCommon
- val storeId: StoreId
- Definition Classes
- InMemoryTopologyStore → TopologyStoreCommon
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Definition Classes
- InMemoryTopologyStore → FlagCloseable
- def timestamp(useStateStore: Boolean)(implicit traceContext: TraceContext): Future[Option[(SequencedTime, EffectiveTime)]]
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateDispatchingWatermark(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
- Definition Classes
- InMemoryTopologyStoreCommon
- def updateState(sequenced: SequencedTime, effective: EffectiveTime, deactivate: Seq[UniquePath], positive: Seq[SignedTopologyTransaction[Positive]])(implicit traceContext: TraceContext): Future[Unit]
update active topology transaction to the active topology transaction table
update active topology transaction to the active topology transaction table
active means that for the key authorizing the transaction, there is a connected path to reach the root certificate
- Definition Classes
- InMemoryTopologyStore → TopologyStore
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])