class DomainTimeTracker extends NamedLogging with FlagCloseable with HasFlushFuture

Provides a variety of methods for tracking time on the domain.

  • fetchTime and fetchTimeProof allows for proactively asking for a recent time or time proof.
  • requestTick asks the tracker to ensure that an event is witnessed for the given time or greater (useful for timeouts).
  • awaitTick will return a future to wait for the given time being reached on the target domain.

We currently assume that the domain and our host are roughly synchronized and typically won't expect to see a time on a domain until we have passed that point on our local clock. We then wait for observationLatency past the timestamp we are expecting to elapse on our local clock as transmission of an event with that timestamp will still take some time to arrive at our host. This avoids frequently asking for times before we've reached the timestamps we're looking for locally.

We also take into account a patienceDuration that will cause us to defer asking for a time if we have recently seen events for the domain. This is particularly useful if we are significantly behind and reading many old events from the domain.

If no activity is happening on the domain we will try to ensure that we have observed an event at least once during the minObservationDuration.

Linear Supertypes
HasFlushFuture, FlagCloseable, AutoCloseable, NamedLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DomainTimeTracker
  2. HasFlushFuture
  3. FlagCloseable
  4. AutoCloseable
  5. NamedLogging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DomainTimeTracker(config: DomainTimeTrackerConfig, clock: Clock, timeRequestSubmitter: TimeProofRequestSubmitter, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def addToFlushAndLogError(name: String)(future: Future[_])(implicit loggingContext: ErrorLoggingContext): Unit

    Adds the task future to the flush future so that doFlush completes only after future has completed.

    Adds the task future to the flush future so that doFlush completes only after future has completed. Logs an error if the future fails with an exception.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  6. def addToFlushWithoutLogging(name: String)(future: Future[_]): Unit

    Adds the task future to the flush future so that doFlush completes only after future has completed.

    Adds the task future to the flush future so that doFlush completes only after future has completed. The caller is responsible for logging any exceptions thrown inside the future.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def awaitTick(ts: CantonTimestamp)(implicit traceContext: TraceContext): Option[Future[CantonTimestamp]]

    Waits for an event with a timestamp greater or equal to ts to be observed from the domain.

    Waits for an event with a timestamp greater or equal to ts to be observed from the domain. If we have already witnessed an event with a timestamp equal or exceeding the given ts then None will be returned.

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. final def close(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    FlagCloseable → AutoCloseable
    Annotations
    @SuppressWarnings()
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  12. def doFlush(): Future[Unit]

    Returns a future that completes after all added futures have completed.

    Returns a future that completes after all added futures have completed. The returned future never fails.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. def fetchTime(freshnessBound: NonNegativeFiniteDuration = NonNegativeFiniteDuration.Zero)(implicit traceContext: TraceContext): FutureUnlessShutdown[CantonTimestamp]

    Fetches a recent domain timestamp.

    Fetches a recent domain timestamp. If the latest received event has been received within the given freshnessBound (measured on the participant clock) this domain timestamp will be immediately returned. If a sufficiently fresh timestamp is unavailable then a request for a time proof will be made, however the returned future will be resolved by the first event after this call (which may not necessarily be the response to our time proof request).

    returns

    The future completes with the domain's timestamp of the event. So if the participant's local clock is ahead of the domain clock, the timestamp may be earlier than now minus the freshness bound.

  17. def fetchTimeProof(freshnessBound: NonNegativeFiniteDuration = NonNegativeFiniteDuration.Zero)(implicit traceContext: TraceContext): FutureUnlessShutdown[TimeProof]

    Similar to fetchTime but will only return time proof.

  18. def flush(): Future[Unit]
    Attributes
    protected[time]
    Annotations
    @VisibleForTesting()
  19. def flushCloseable(name: String, timeout: NonNegativeDuration): SyncCloseable
    Attributes
    protected
    Definition Classes
    HasFlushFuture
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  23. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    FlagCloseable
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    FlagCloseable
  26. def latestTime: Option[CantonTimestamp]

    Fetch the latest timestamp we have observed from the domain.

    Fetch the latest timestamp we have observed from the domain. Note this isn't restored on startup so will be empty until the first event after starting is seen.

  27. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DomainTimeTracker → NamedLogging
  29. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  30. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def onClosed(): Unit
    Definition Classes
    DomainTimeTracker → FlagCloseable
  36. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    FlagCloseable
  37. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    FlagCloseable
  38. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  39. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  40. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  41. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    FlagCloseable
  42. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  43. def requestTick(ts: CantonTimestamp)(implicit traceContext: TraceContext): Unit

    Register that we want to observe a domain time.

    Register that we want to observe a domain time. The tracker will attempt to make sure that we observe a sequenced event with this timestamp or greater.

    The maximum timestamp that we support waiting for is data.CantonTimestamp.MaxValue minus the configured observation latency. If a greater value is provided a warning will be logged but no error will be thrown or returned.

  44. def requestTicks(timestamps: Seq[CantonTimestamp])(implicit traceContext: TraceContext): Unit

    Register that we want to observe domain times.

    Register that we want to observe domain times. The tracker will attempt to make sure that we observe a sequenced event with the given timestamps or greater.

    The maximum timestamp that we support waiting for is data.CantonTimestamp.MaxValue minus the configured observation latency. If a greater value is provided a warning will be logged but no error will be thrown or returned.

  45. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    FlagCloseable
  46. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  47. def subscriptionResumesAfter(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Unit

    Inform the domain time tracker about the first message the sequencer client resubscribes to from the sequencer.

    Inform the domain time tracker about the first message the sequencer client resubscribes to from the sequencer. This is never considered a time proof event.

  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DomainTimeTracker → FlagCloseable
  50. def toString(): String
    Definition Classes
    AnyRef → Any
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. def wrapHandler[Env <: Envelope[_]](handler: OrdinaryApplicationHandler[Env]): OrdinaryApplicationHandler[Env]

    Create a sequencing.OrdinaryApplicationHandler for updating this time tracker

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from HasFlushFuture

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped