class InFlightSubmissionTracker extends FlagCloseable with NamedLogging

Tracker for in-flight submissions backed by the com.digitalasset.canton.participant.store.InFlightSubmissionStore.

A submission is in flight if it is in the com.digitalasset.canton.participant.store.InFlightSubmissionStore. The tracker registers a submission before the com.digitalasset.canton.sequencing.protocol.SubmissionRequest is sent to the com.digitalasset.canton.sequencing.client.SequencerClient of a domain. After the corresponding event has been published into the com.digitalasset.canton.participant.store.MultiDomainEventLog state updates, the submission will be removed from the com.digitalasset.canton.participant.store.InFlightSubmissionStore again. This happens normally as part of request processing after phase 7. If the submission has not been sequenced by the specified com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout, say because the submission was lost on the way to the sequencer, the participant generates an appropriate update because the submission will never reach request processing. The latter must work even if the participant crashes (if run with persistence).

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InFlightSubmissionTracker
  2. NamedLogging
  3. FlagCloseable
  4. PerformUnlessClosing
  5. OnShutdownRunner
  6. AutoCloseable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new InFlightSubmissionTracker(store: Eval[InFlightSubmissionStore], participantEventPublisher: ParticipantEventPublisher, deduplicator: CommandDeduplicator, multiDomainEventLog: Eval[MultiDomainEventLog], domainStates: (DomainId) => Option[InFlightSubmissionTrackerDomainState], timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

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 cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  9. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  10. implicit val ec: ExecutionContext
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  17. 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
    OnShutdownRunner
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
    PerformUnlessClosing
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    InFlightSubmissionTrackerNamedLogging
  22. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  23. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def observeDeliverError(deliverError: DeliverError)(implicit traceContext: TraceContext): Future[Unit]

    Updates the unsequenced submission corresponding to the com.digitalasset.canton.sequencing.protocol.DeliverError, if any, using com.digitalasset.canton.participant.protocol.submission.SubmissionTrackingData.updateOnNotSequenced.

  29. def observeSequencedRootHash(rootHash: RootHash, submission: SequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]

    See also

    com.digitalasset.canton.participant.store.InFlightSubmissionStore.observeSequencedRootHash

  30. def observeSequencing(domainId: DomainId, sequenceds: Map[MessageId, SequencedSubmission])(implicit traceContext: TraceContext): Future[Unit]

    See also

    com.digitalasset.canton.participant.store.InFlightSubmissionStore.observeSequencing

  31. def observeSubmissionError(changeIdHash: ChangeIdHash, domainId: DomainId, messageId: MessageId, newTrackingData: UnsequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]

    See also

    com.digitalasset.canton.participant.store.InFlightSubmissionStore.updateUnsequenced

  32. def observeTimestamp(domainId: DomainId, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, UnknownDomain, Unit]

    Marks the timestamp as having been observed on the domain.

  33. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  34. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  35. final def onFirstClose(): 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
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  36. val onPublishListener: OnPublish
  37. 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
    PerformUnlessClosing
  38. 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
    PerformUnlessClosing
  39. 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
    PerformUnlessClosing
  40. 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
    PerformUnlessClosing
  41. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  42. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  43. 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
    PerformUnlessClosing
  44. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  45. def recoverDomain(domainId: DomainId, upToInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    Deletes the published, sequenced in-flight submissions with sequencing timestamps up to the given bound and informs the CommandDeduplicator about the published events.

    Deletes the published, sequenced in-flight submissions with sequencing timestamps up to the given bound and informs the CommandDeduplicator about the published events.

    upToInclusive

    Upper bound on the sequencing time of the submissions to be recovered. The com.digitalasset.canton.participant.sync.LedgerSyncEvents for all sequenced submissions up to this bound must have been published to the com.digitalasset.canton.participant.store.MultiDomainEventLog. The com.digitalasset.canton.participant.sync.LedgerSyncEvents for all sequenced submissions in the com.digitalasset.canton.participant.store.InFlightSubmissionStore must not yet have been pruned from the com.digitalasset.canton.participant.store.MultiDomainEventLog.

  46. def recoverPublishedTimelyRejections(domains: Seq[DomainId])(implicit traceContext: TraceContext): Future[Unit]

    Completes all unsequenced in-flight submissions for the given domains for which a timely rejection event has been published in the com.digitalasset.canton.participant.store.MultiDomainEventLog.

  47. def register(submission: InFlightSubmission[UnsequencedSubmission], deduplicationPeriod: DeduplicationPeriod): EitherT[FutureUnlessShutdown, InFlightSubmissionTrackerError, Either[DeduplicationFailed, DeduplicationOffset]]

    Registers the given submission as being in flight and unsequenced unless there already is an in-flight submission for the same change ID or the timeout has already elapsed.

    Registers the given submission as being in flight and unsequenced unless there already is an in-flight submission for the same change ID or the timeout has already elapsed.

    returns

    The actual deduplication offset that is being used for deduplication for this submission

  48. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  49. 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
    OnShutdownRunner
  50. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def timelyReject(domainId: DomainId, upToInclusive: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownDomain, Unit]

    Publishes the rejection events for all unsequenced submissions on domainId up to the given timestamp.

    Publishes the rejection events for all unsequenced submissions on domainId up to the given timestamp. Does not remove the submissions from the in-flight table as this will happen by the onPublishListener called by the com.digitalasset.canton.participant.store.MultiDomainEventLog.

  53. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    InFlightSubmissionTrackerFlagCloseable
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. def updateRegistration(submission: InFlightSubmission[UnsequencedSubmission], rootHash: RootHash): Future[Unit]

    See also

    com.digitalasset.canton.participant.store.InFlightSubmissionStore.updateRegistration

  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  58. 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
    Deprecated

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped