trait TopologyClientApi[T] extends AnyRef
- Alphabetic
- By Inheritance
- 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) to elapse
- abstract def awaitSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[T]
Waits until a snapshot is available
- 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.
- abstract def currentSnapshotApproximation(implicit traceContext: TraceContext): T
Our current snapshot approximation
Our current snapshot approximation
As topology transactions are future dated (to prevent sequential bottlenecks), we do have to "guess" the current state, as time is defined by the sequencer after we've sent the transaction. Therefore, this function will return the best snapshot approximation known.
- abstract def domainId: DomainId
The domain this client applies to
- abstract def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[T]
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
- abstract def snapshotAvailable(timestamp: CantonTimestamp): Boolean
Returns true if the topology information at the passed timestamp is already known
- 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
- abstract def trySnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): T
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.
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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def headSnapshot(implicit traceContext: TraceContext): T
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.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])