trait DomainTopologyClientWithInit extends DomainTopologyClient with TopologyTransactionProcessingSubscriber with NamedLogging
The internal domain topology client interface used for initialisation and efficient processing
- Alphabetic
- By Inheritance
- DomainTopologyClientWithInit
- NamedLogging
- TopologyTransactionProcessingSubscriber
- DomainTopologyClient
- 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) to elapse
- 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
- DomainTopologyClient
- 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
- abstract def awaitTimestampUS(timestamp: CantonTimestamp, waitForEffectiveTime: Boolean)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
- Definition Classes
- TopologyClientApi
- abstract def close(): Unit
- Definition Classes
- AutoCloseable
- Annotations
- @throws(classOf[java.lang.Exception])
- abstract def currentSnapshotApproximation(implicit traceContext: TraceContext): TopologySnapshotLoader
Overloaded recent snapshot returning derived type
Overloaded recent snapshot returning derived type
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- abstract def domainId: DomainId
The domain this client applies to
The domain this client applies to
- Definition Classes
- TopologyClientApi
- implicit abstract def executionContext: ExecutionContext
- 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[SignedTopologyTransaction[TopologyChangeOp]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- Definition Classes
- TopologyTransactionProcessingSubscriber
- 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 subscribe(subscriber: Subscriber): Unit
Subscribe to topology information updates
Subscribe to topology information updates
- Definition Classes
- DomainTopologyClient
- 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
- 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
- DomainTopologyClientWithInit → TopologyClientApi
- abstract def unsubscribe(subscriber: Subscriber): Unit
Remove observer from topology information updates
Remove observer from topology information updates
- Definition Classes
- DomainTopologyClient
- 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
- DomainTopologyClientWithInit → TopologyTransactionProcessingSubscriber
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 awaitSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshot]
Waits until a snapshot is available
Waits until a snapshot is available
- Definition Classes
- DomainTopologyClientWithInit → 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 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): 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshotLoader]
Overloaded snapshot returning derived type
Overloaded snapshot returning derived type
- Definition Classes
- DomainTopologyClientWithInit → TopologyClientApi
- 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])