trait SynchronizerTopologyClientWithInit extends SynchronizerTopologyClient with TopologyTransactionProcessingSubscriber with HasFutureSupervision with NamedLogging
The internal synchronizer topology client interface used for initialisation and efficient processing
- Alphabetic
- By Inheritance
- SynchronizerTopologyClientWithInit
- NamedLogging
- HasFutureSupervision
- TopologyTransactionProcessingSubscriber
- SynchronizerTopologyClient
- AutoCloseable
- TopologyClientApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def approximateTimestamp: CantonTimestamp
The approximate timestamp
The approximate timestamp
This is either the last observed sequencer timestamp OR the effective timestamp after we observed the time difference of (effective - sequencer = epsilon)
- Definition Classes
- TopologyClientApi
- abstract 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
- SynchronizerTopologyClient
- abstract def awaitMaxTimestamp(sequencedTime: SequencedTime)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[(SequencedTime, EffectiveTime)]]
Finds the transaction with maximum effective time that has been sequenced before or at
sequencedTimeand yields the sequenced / effective time of that transaction.Finds the transaction with maximum effective time that has been sequenced before or at
sequencedTimeand yields the sequenced / effective time of that transaction. Potentially waits forsequencedTimeto be observed.- Definition Classes
- TopologyClientApi
- abstract def awaitSequencedTimestamp(timestampInclusive: SequencedTime)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
Returns an optional future which will complete when the sequenced timestamp has been observed
Returns an optional future which will complete when the sequenced timestamp has been observed
If the timestamp is already observed, returns None.
- Definition Classes
- TopologyClientApi
- abstract def awaitTimestamp(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
Returns an optional future which will complete when the effective timestamp has been observed
Returns an optional future which will complete when the effective timestamp has been observed
If the timestamp is already observed, returns None.
- Definition Classes
- TopologyClientApi
- abstract def awaitUS(condition: (TopologySnapshot) => FutureUnlessShutdown[Boolean], timeout: Duration)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
- Definition Classes
- SynchronizerTopologyClient
- abstract def close(): Unit
- Definition Classes
- AutoCloseable
- Annotations
- @throws(classOf[java.lang.Exception])
- implicit abstract def executionContext: ExecutionContext
- Attributes
- protected
- Definition Classes
- SynchronizerTopologyClientWithInit → HasFutureSupervision
- abstract def futureSupervisor: FutureSupervisor
- Attributes
- protected
- Definition Classes
- HasFutureSupervision
- abstract def hypotheticalSnapshot(timestamp: CantonTimestamp, desiredTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshot]
Returns the topology information at the
timestamppoint in time, but usingdesiredTimestampas the actual "forwarded" timestamp.Returns the topology information at the
timestamppoint in time, but usingdesiredTimestampas the actual "forwarded" timestamp.The snapshot returned by this method should ONLY BE USED when computing the timestamp for signature validation (i.e. com.digitalasset.canton.crypto.SyncCryptoClient.getSnapshotForTimestamp).
- Definition Classes
- TopologyClientApi
- abstract def loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- NamedLogging
- abstract def numPendingChanges: Int
current number of changes waiting to become effective
- abstract def observed(sequencedTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime, sequencerCounter: SequencerCounter, transactions: Seq[GenericSignedTopologyTransaction])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
This must be called whenever a topology transaction is committed.
This must be called whenever a topology transaction is committed. It may be called at additional timestamps with
transactionsbeing empty. Calls must have strictly increasingsequencedTimestampandeffectiveTimestamp.During crash recovery previous calls of this method may be replayed. Therefore, implementations must be idempotent.
The effective timestamp may have not yet been reached on the synchronizer.
- Definition Classes
- TopologyTransactionProcessingSubscriber
- abstract def psid: PhysicalSynchronizerId
The synchronizer this client applies to
The synchronizer this client applies to
- Definition Classes
- TopologyClientApi
- abstract def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshot]
Returns the topology information at a certain point in time
Returns the topology information at a certain point in time
Use this method if you are sure to be synchronized with the topology state updates. The method will block & wait for an update, but emit a warning if it is not available
The snapshot returned by this method should be used for validating transaction and reassignment 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
- TopologyClientApi
- abstract def snapshotAvailable(timestamp: CantonTimestamp): Boolean
Returns true if the topology information at the passed timestamp is already known
Returns true if the topology information at the passed timestamp is already known
- Definition Classes
- TopologyClientApi
- abstract def staticSynchronizerParameters: StaticSynchronizerParameters
- Definition Classes
- TopologyClientApi
- abstract def synchronizerId: SynchronizerId
- Definition Classes
- TopologyClientApi
- abstract 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 synchronizer parameters.
This is the highest timestamp for which we can serve snapshots
- Definition Classes
- TopologyClientApi
- abstract def trySnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): TopologySnapshotLoader
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 reassignment 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.
- Attributes
- protected[topology]
- Definition Classes
- SynchronizerTopologyClient
Concrete 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def awaitSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[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 reassignment 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
- SynchronizerTopologyClientWithInit → TopologyClientApi
- def awaitSnapshotUSSupervised(description: => String, warnAfter: Duration = 30.seconds)(timestamp: CantonTimestamp)(implicit loggingContext: ErrorLoggingContext): FutureUnlessShutdown[TopologySnapshot]
Supervised version of awaitSnapshot
Supervised version of awaitSnapshot
- Definition Classes
- TopologyClientApi
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def currentSnapshotApproximation(implicit traceContext: TraceContext): TopologySnapshotLoader
Overloaded recent snapshot returning derived type
Overloaded recent snapshot returning derived type
- Definition Classes
- SynchronizerTopologyClientWithInit → 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
- def executionOrder: Int
The order in which the subscriber should be executed among all the subscriptions.
The order in which the subscriber should be executed among all the subscriptions. Lower values are executed first.
- Definition Classes
- TopologyTransactionProcessingSubscriber
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def headSnapshot(implicit traceContext: TraceContext): TopologySnapshotLoader
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 prepare regular transactions using this snapshot, but use the currentSnapshotApproximation instead. A head snapshot can be useful, however, for producing new topology changes, e.g., for picking the correct serial.
- Definition Classes
- SynchronizerTopologyClientWithInit → TopologyClientApi
- def initialize()(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- 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()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def protocolVersion: ProtocolVersion
- Definition Classes
- TopologyClientApi
- def setSynchronizerTimeTracker(tracker: SynchronizerTimeTracker): Unit
- def supervised[T](description: => String, warnAfter: Duration = 10.seconds)(fut: Future[T])(implicit loggingContext: ErrorLoggingContext): Future[T]
- Attributes
- protected
- Definition Classes
- HasFutureSupervision
- def supervisedUS[T](description: => String, warnAfter: Duration = 10.seconds)(fut: FutureUnlessShutdown[T])(implicit loggingContext: ErrorLoggingContext): FutureUnlessShutdown[T]
- Definition Classes
- HasFutureSupervision
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val synchronizerTimeTracker: SingleUseCell[SynchronizerTimeTracker]
- Attributes
- protected
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateHead(sequencedTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime, approximateTimestamp: ApproximateTime)(implicit traceContext: TraceContext): Unit
Move the highest known (effective / approximate) timestamp ahead in the future.
Move the highest known (effective / approximate) timestamp ahead in the future.
May only be called if:
- All committed topology transactions with effective time up to
effectiveTimestamphave been persisted in the topology store. - All committed topology transactions with sequenced time up to
sequencedTimestamphave been persisted in the topology store. sequencedTimestamp <= effectiveTimestampapproximateTimestamp <= effectiveTimestamp- A sequenced event with timestamp at least
approximateTimestamphas been received from the sequencer.
The effective timestamp may have not yet been reached on the synchronizer.
- Definition Classes
- TopologyTransactionProcessingSubscriber
- All committed topology transactions with effective time up to
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- def waitForTimestampWithLogging(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- Attributes
- protected