t

com.digitalasset.canton.topology.client

SynchronizerTopologyClientWithInit

trait SynchronizerTopologyClientWithInit extends SynchronizerTopologyClient with TopologyTransactionProcessingSubscriber with HasFutureSupervision with NamedLogging

The internal synchronizer topology client interface used for initialisation and efficient processing

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SynchronizerTopologyClientWithInit
  2. NamedLogging
  3. HasFutureSupervision
  4. TopologyTransactionProcessingSubscriber
  5. SynchronizerTopologyClient
  6. AutoCloseable
  7. TopologyClientApi
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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
  2. 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
  3. 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 sequencedTime and yields the sequenced / effective time of that transaction.

    Finds the transaction with maximum effective time that has been sequenced before or at sequencedTime and yields the sequenced / effective time of that transaction. Potentially waits for sequencedTime to be observed.

    Definition Classes
    TopologyClientApi
  4. 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
  5. 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
  6. abstract def awaitUS(condition: (TopologySnapshot) => FutureUnlessShutdown[Boolean], timeout: Duration)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Definition Classes
    SynchronizerTopologyClient
  7. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  8. implicit abstract def executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    SynchronizerTopologyClientWithInitHasFutureSupervision
  9. abstract def futureSupervisor: FutureSupervisor
    Attributes
    protected
    Definition Classes
    HasFutureSupervision
  10. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  11. abstract def numPendingChanges: Int

    current number of changes waiting to become effective

  12. 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 transactions being empty. Calls must have strictly increasing sequencedTimestamp and effectiveTimestamp. The effectiveTimestamp must be the one computed by com.digitalasset.canton.topology.processing.TopologyTimestampPlusEpsilonTracker for sequencedTimestamp.

    During crash recovery previous calls of this method may be replayed. Therefore, implementations must be idempotent.

    Definition Classes
    TopologyTransactionProcessingSubscriber
  13. 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
  14. abstract def synchronizerId: SynchronizerId

    The synchronizer this client applies to

    The synchronizer this client applies to

    Definition Classes
    TopologyClientApi
  15. 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
  16. 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.

    Definition Classes
    SynchronizerTopologyClientWithInitTopologyClientApi

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 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
    SynchronizerTopologyClientWithInitTopologyClientApi
  6. 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
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def currentSnapshotApproximation(implicit traceContext: TraceContext): TopologySnapshotLoader

    Overloaded recent snapshot returning derived type

    Overloaded recent snapshot returning derived type

    Definition Classes
    SynchronizerTopologyClientWithInitTopologyClientApi
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  12. 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
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. 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
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. def setSynchronizerTimeTracker(tracker: SynchronizerTimeTracker): Unit
  24. def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshotLoader]

    Overloaded snapshot returning derived type

    Overloaded snapshot returning derived type

    Definition Classes
    SynchronizerTopologyClientWithInitTopologyClientApi
  25. def supervised[T](description: => String, warnAfter: Duration = 10.seconds)(fut: Future[T])(implicit loggingContext: ErrorLoggingContext): Future[T]
    Attributes
    protected
    Definition Classes
    HasFutureSupervision
  26. def supervisedUS[T](description: => String, warnAfter: Duration = 10.seconds)(fut: FutureUnlessShutdown[T])(implicit loggingContext: ErrorLoggingContext): FutureUnlessShutdown[T]
    Definition Classes
    HasFutureSupervision
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. val synchronizerTimeTracker: SingleUseCell[SynchronizerTimeTracker]
    Attributes
    protected
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. def updateHead(sequencedTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime, approximateTimestamp: ApproximateTime, potentialTopologyChange: Boolean)(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:

    1. All committed topology transactions with effective time up to effectiveTimestamp have been persisted in the topology store.
    2. All committed topology transactions with sequenced time up to sequencedTimestamp have been persisted in the topology store.
    3. If this method is called with potentialTopologyChange == true, then for every subsequent committed topology transaction either updateHead(potentialTopologyChange == true, ...) or observed must be called again; such calls must occur with ascending effective timestamps.
    4. sequencedTimestamp <= effectiveTimestamp
    5. approximateTimestamp <= effectiveTimestamp
    6. A sequenced event with timestamp at least approximateTimestamp has been received from the sequencer.
    Definition Classes
    TopologyTransactionProcessingSubscriber
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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

    (Since version 9)

Inherited from NamedLogging

Inherited from HasFutureSupervision

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped