com.digitalasset.canton.topology.client
StoreBasedDomainTopologyClient
Companion object StoreBasedDomainTopologyClient
class StoreBasedDomainTopologyClient extends BaseDomainTopologyClientOld with NamedLogging
The domain topology client that reads data from a topology store
- Alphabetic
- By Inheritance
- StoreBasedDomainTopologyClient
- BaseDomainTopologyClientOld
- DomainTopologyClientWithInitOld
- TopologyTransactionProcessingSubscriber
- BaseDomainTopologyClient
- TimeAwaiter
- TopologyAwaiter
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- DomainTopologyClientWithInit
- NamedLogging
- HasFutureSupervision
- TopologyTransactionProcessingSubscriberCommon
- DomainTopologyClient
- AutoCloseable
- TopologyClientApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StoreBasedDomainTopologyClient(clock: Clock, domainId: DomainId, protocolVersion: ProtocolVersion, store: TopologyStore[TopologyStoreId], initKeys: Map[KeyOwner, Seq[SigningPublicKey]], packageDependencies: PackageDependencyResolverUS, timeouts: ProcessingTimeout, futureSupervisor: FutureSupervisor, loggerFactory: NamedLoggerFactory, useStateTxs: Boolean = true)(implicit executionContext: ExecutionContext)
- domainId
The domain-id corresponding to this store
- store
The store
- initKeys
The set of initial keys that should be mixed in in case we fetched an empty set of keys
- useStateTxs
Whether we use the state store or the transaction store. Generally, we use the state store except in the authorized store
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 approximateTimestamp: CantonTimestamp
returns the current approximate timestamp
returns the current approximate timestamp
whenever we get an update, we do set the approximate timestamp first to the sequencer time and schedule an update on the clock to advance the approximate time to the effective time after the time difference elapsed.
- Definition Classes
- BaseDomainTopologyClient → TopologyClientApi
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def await(condition: (TopologySnapshot) => Future[Boolean], timeout: Duration)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
Wait for a condition to become true according to the current snapshot approximation
Wait for a condition to become true according to the current snapshot approximation
- returns
true if the condition became true, false if it timed out
- Definition Classes
- BaseDomainTopologyClient → DomainTopologyClient
- def awaitKnownTimestamp(timestamp: CantonTimestamp): Option[Future[Unit]]
- Attributes
- protected
- Definition Classes
- TimeAwaiter
- def awaitKnownTimestampUS(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
- Attributes
- protected
- Definition Classes
- TimeAwaiter
- def awaitSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshot]
Waits until a snapshot is available
Waits until a snapshot is available
The snapshot returned by this method should be used for validating transaction and transfer requests (Phase 2 - 7). Use the request timestamp as parameter for this method. Do not use a response or result timestamp, because all validation steps must use the same topology snapshot.
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- def awaitSnapshotSupervised(description: => String, warnAfter: Duration = 30.seconds)(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshot]
Supervised version of awaitSnapshot
Supervised version of awaitSnapshot
- Definition Classes
- TopologyClientApi
- def awaitSnapshotUS(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshot]
Shutdown safe version of await snapshot
Shutdown safe version of await snapshot
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- def awaitSnapshotUSSupervised(description: => String, warnAfter: Duration = 30.seconds)(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshot]
Supervised version of awaitSnapshotUS
Supervised version of awaitSnapshotUS
- Definition Classes
- TopologyClientApi
- def awaitTimestamp(timestamp: CantonTimestamp, waitForEffectiveTime: Boolean)(implicit traceContext: TraceContext): Option[Future[Unit]]
Returns an optional future which will complete when the timestamp has been observed
Returns an optional future which will complete when the timestamp has been observed
If the timestamp is already observed, we return None.
Note that this function allows to wait for effective time (true) and sequenced time (false). If we wait for effective time, we wait until the topology snapshot for that given point in time is known. As we future date topology transactions (to avoid bottlenecks), this might be before we actually observed a sequencing timestamp.
- Definition Classes
- BaseDomainTopologyClient → TopologyClientApi
- def awaitTimestampUS(timestamp: CantonTimestamp, waitForEffectiveTime: Boolean)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
- Definition Classes
- BaseDomainTopologyClient → TopologyClientApi
- 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 checkAwaitingConditions()(implicit traceContext: TraceContext): Unit
- Attributes
- protected
- Definition Classes
- TopologyAwaiter
- val clock: Clock
- Definition Classes
- StoreBasedDomainTopologyClient → TopologyAwaiter
- 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 currentKnownTime: CantonTimestamp
- Attributes
- protected
- Definition Classes
- BaseDomainTopologyClient → TimeAwaiter
- def currentSnapshotApproximation(implicit traceContext: TraceContext): TopologySnapshotLoader
Overloaded recent snapshot returning derived type
Overloaded recent snapshot returning derived type
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- val domainId: DomainId
The domain this client applies to
The domain this client applies to
- Definition Classes
- StoreBasedDomainTopologyClient → TopologyClientApi
- 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
- implicit val executionContext: ExecutionContext
- Definition Classes
- StoreBasedDomainTopologyClient → DomainTopologyClientWithInit → HasFutureSupervision
- def expireTimeAwaiter(): Unit
- Attributes
- protected
- Definition Classes
- TimeAwaiter
- val futureSupervisor: FutureSupervisor
- Attributes
- protected
- Definition Classes
- StoreBasedDomainTopologyClient → HasFutureSupervision
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def headSnapshot(implicit traceContext: TraceContext): TopologySnapshot
Possibly future dated head snapshot
Possibly future dated head snapshot
As we future date topology transactions, the head snapshot is our latest knowledge of the topology state, but as it can be still future dated, we need to be careful when actually using it: the state might not yet be active, as the topology transactions are future dated. Therefore, do not act towards the sequencer using this snapshot, but use the currentSnapshotApproximation instead.
- Definition Classes
- TopologyClientApi
- 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
performUnlessClosing
and 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
- StoreBasedDomainTopologyClient → 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
- 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 notifyAwaitedFutures(upToInclusive: CantonTimestamp): Unit
- Attributes
- protected
- Definition Classes
- TimeAwaiter
- def numPendingChanges: Int
current number of changes waiting to become effective
current number of changes waiting to become effective
- Definition Classes
- BaseDomainTopologyClient → DomainTopologyClientWithInit
- def observed(sequencedTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime, sequencerCounter: SequencerCounter, transactions: Seq[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- Definition Classes
- BaseDomainTopologyClientOld → TopologyTransactionProcessingSubscriber
- def observedInternal(sequencedTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- Attributes
- protected
- Definition Classes
- BaseDomainTopologyClient
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- BaseDomainTopologyClient → TopologyAwaiter → 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
f
unless a shutdown has been initiated.Performs the task given by
f
unless a shutdown has been initiated. The shutdown will only begin afterf
completes, 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.close
as 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
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. Bothetf
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 afteretf
completes, 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.close
as 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
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 afterf
completes, 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.close
as 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
- val protocolVersion: ProtocolVersion
- Definition Classes
- StoreBasedDomainTopologyClient → BaseDomainTopologyClient
- 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 snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshotLoader]
Overloaded snapshot returning derived type
Overloaded snapshot returning derived type
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- def snapshotAvailable(timestamp: CantonTimestamp): Boolean
Returns whether a snapshot for the given timestamp is available.
Returns whether a snapshot for the given timestamp is available.
- Definition Classes
- BaseDomainTopologyClient → TopologyClientApi
- def snapshotUS(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshotLoader]
Overloaded snapshot returning derived type
Overloaded snapshot returning derived type
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- def supervised[T](description: => String, warnAfter: Duration = 10.seconds)(fut: Future[T])(implicit traceContext: TraceContext): Future[T]
- Attributes
- protected
- Definition Classes
- HasFutureSupervision
- def supervisedUS[T](description: => String, warnAfter: Duration = 10.seconds)(fut: FutureUnlessShutdown[T])(implicit traceContext: TraceContext): FutureUnlessShutdown[T]
- Definition Classes
- HasFutureSupervision
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Definition Classes
- StoreBasedDomainTopologyClient → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def topologyKnownUntilTimestamp: CantonTimestamp
The most recently observed effective timestamp
The most recently observed effective timestamp
The effective timestamp is sequencer_time + epsilon(sequencer_time), where epsilon is given by the topology change delay time, defined using the domain parameters.
This is the highest timestamp for which we can serve snapshots
- Definition Classes
- BaseDomainTopologyClient → TopologyClientApi
- def trySnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): StoreBasedTopologySnapshot
Returns the topology information at a certain point in time
Returns the topology information at a certain point in time
Fails with an exception if the state is not yet known.
The snapshot returned by this method should be used for validating transaction and transfer requests (Phase 2 - 7). Use the request timestamp as parameter for this method. Do not use a response or result timestamp, because all validation steps must use the same topology snapshot.
- Definition Classes
- StoreBasedDomainTopologyClient → DomainTopologyClientWithInit → TopologyClientApi
- def updateHead(effectiveTimestamp: EffectiveTime, approximateTimestamp: ApproximateTime, potentialTopologyChange: Boolean)(implicit traceContext: TraceContext): Unit
Move the most known timestamp ahead in future based of newly discovered information
Move the most known timestamp ahead in future based of newly discovered information
We don't know the most recent timestamp directly. However, we can guess it from two sources: What was the timestamp of the latest topology transaction added? And what was the last processing timestamp. We need to know both such that we can always deliver the latest valid set of topology information, and don't use old snapshots. Therefore, we expose the updateHead function on the public interface for initialisation purposes.
- effectiveTimestamp
sequencer timestamp + epsilon(sequencer timestamp)
- approximateTimestamp
our current best guess of what the "best" timestamp is to get a valid current topology snapshot
- potentialTopologyChange
if true, the time advancement is related to a topology change that might have occurred or become effective
- Definition Classes
- BaseDomainTopologyClient → TopologyTransactionProcessingSubscriberCommon
- 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])