t

com.digitalasset.canton.topology.client

DomainTopologyClientWithInit

trait DomainTopologyClientWithInit extends DomainTopologyClient with TopologyTransactionProcessingSubscriber with HasFutureSupervision with NamedLogging

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DomainTopologyClientWithInit
  2. NamedLogging
  3. HasFutureSupervision
  4. TopologyTransactionProcessingSubscriber
  5. DomainTopologyClient
  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) to elapse

    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
    DomainTopologyClient
  3. abstract 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
    TopologyClientApi
  4. abstract def awaitTimestampUS(timestamp: CantonTimestamp, waitForEffectiveTime: Boolean)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
    Definition Classes
    TopologyClientApi
  5. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  6. abstract def currentSnapshotApproximation(implicit traceContext: TraceContext): TopologySnapshotLoader

    Overloaded recent snapshot returning derived type

    Overloaded recent snapshot returning derived type

    Definition Classes
    DomainTopologyClientWithInitTopologyClientApi
  7. abstract def domainId: DomainId

    The domain this client applies to

    The domain this client applies to

    Definition Classes
    TopologyClientApi
  8. implicit abstract def executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    DomainTopologyClientWithInitHasFutureSupervision
  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[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
  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 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
    TopologyClientApi
  15. 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.

    Definition Classes
    DomainTopologyClientWithInitTopologyClientApi
  16. abstract 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
    DomainTopologyClientWithInitTopologyTransactionProcessingSubscriber

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): Future[TopologySnapshot]

    Waits until a snapshot is available

    Waits until a snapshot is available

    Definition Classes
    DomainTopologyClientWithInitTopologyClientApi
  6. def awaitSnapshotSupervised(description: => String, warnAfter: Duration = 10.seconds)(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshot]

    Supervised version of awaitSnapshot

    Supervised version of awaitSnapshot

    Definition Classes
    TopologyClientApi
  7. def awaitSnapshotUS(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshot]

    Shutdown safe version of await snapshot

    Shutdown safe version of await snapshot

    Definition Classes
    DomainTopologyClientWithInitTopologyClientApi
  8. def awaitSnapshotUSSupervised(description: => String, warnAfter: Duration = 10.seconds)(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[TopologySnapshot]

    Supervised version of awaitSnapshotUS

    Supervised version of awaitSnapshotUS

    Definition Classes
    TopologyClientApi
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshotLoader]

    Overloaded snapshot returning derived type

    Overloaded snapshot returning derived type

    Definition Classes
    DomainTopologyClientWithInitTopologyClientApi
  24. def supervised[T](description: => String, warnAfter: Duration = 10.seconds)(fut: Future[T])(implicit traceContext: TraceContext): Future[T]
    Attributes
    protected
    Definition Classes
    HasFutureSupervision
  25. def supervisedUS[T](description: => String, warnAfter: Duration = 10.seconds)(fut: FutureUnlessShutdown[T])(implicit traceContext: TraceContext): FutureUnlessShutdown[T]
    Definition Classes
    HasFutureSupervision
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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

Inherited from NamedLogging

Inherited from HasFutureSupervision

Inherited from DomainTopologyClient

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped