com.digitalasset.canton.participant.protocol.submission
InFlightSubmissionTracker
Companion object InFlightSubmissionTracker
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).
- Alphabetic
- By Inheritance
- InFlightSubmissionTracker
- NamedLogging
- FlagCloseable
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new InFlightSubmissionTracker(store: InFlightSubmissionStore, participantEventPublisher: ParticipantEventPublisher, deduplicator: CommandDeduplicator, multiDomainEventLog: MultiDomainEventLog, domainStates: (DomainId) => Option[InFlightSubmissionTrackerDomainState], timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
- domainStates
The projection of the com.digitalasset.canton.participant.store.SyncDomainEphemeralState to what the InFlightSubmissionTracker uses.
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- 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 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()
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- implicit val ec: ExecutionContext
- 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 internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- InFlightSubmissionTracker → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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 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.
- def observeSequencing(domainId: DomainId, sequenceds: Map[MessageId, SequencedSubmission])(implicit traceContext: TraceContext): Future[Unit]
- See also
com.digitalasset.canton.participant.store.InFlightSubmissionStore.observeSequencing
- def observeSubmissionError(changeIdHash: ChangeIdHash, domainId: DomainId, messageId: MessageId, newTrackingData: UnsequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]
- See also
com.digitalasset.canton.participant.store.InFlightSubmissionStore.updateUnsequenced
- def observeTimestamp(domainId: DomainId, timestamp: CantonTimestamp): EitherT[Future, UnknownDomain, Unit]
Marks the timestamp as having been observed on the domain.
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val onPublishListener: OnPublish
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- 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
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, 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.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
- 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.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.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.
- 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.
- 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
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timelyReject(domainId: DomainId, upToInclusive: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, UnknownDomain, Unit]
Publishes the rejection events for all unsequenced submissions on
domainIdup to the given timestamp.Publishes the rejection events for all unsequenced submissions on
domainIdup 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. - val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- InFlightSubmissionTracker → FlagCloseable
- 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])