com.digitalasset.canton.participant.store.db
DbInFlightSubmissionStore
Companion object DbInFlightSubmissionStore
class DbInFlightSubmissionStore extends InFlightSubmissionStore with DbStore
- Self Type
- DbInFlightSubmissionStore
- Alphabetic
- By Inheritance
- DbInFlightSubmissionStore
- DbStore
- HasCloseContext
- PromiseUnlessShutdownFactory
- NamedLogging
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- InFlightSubmissionStore
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbInFlightSubmissionStore(storage: DbStorage, maxItemsInSqlInClause: PositiveNumeric[Int], registerBatchAggregatorConfig: BatchAggregatorConfig, releaseProtocolVersion: ReleaseProtocolVersion, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)
Type Members
- case class SequencedRootHash(rootHash: RootHash, submission: SequencedSubmission) extends PrettyPrinting with Product with Serializable
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 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
- 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 → OnShutdownRunner → AutoCloseable
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- def delete(submissions: Seq[InFlightReference])(implicit traceContext: TraceContext): Future[Unit]
Deletes the referred to in-flight submissions if there are any.
Deletes the referred to in-flight submissions if there are any.
If the com.digitalasset.canton.sequencing.protocol.MessageId in com.digitalasset.canton.participant.store.InFlightSubmissionStore.InFlightByMessageId is not a UUID, there cannot be a matching in-flight submission because register forces a UUID for the message ID.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- 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
- PerformUnlessClosing
- 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
- 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
- PerformUnlessClosing
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbInFlightSubmissionStore → NamedLogging
- def lookup(changeIdHash: ChangeIdHash)(implicit traceContext: TraceContext): OptionT[Future, InFlightSubmission[SubmissionSequencingInfo]]
Retrieves the in-flight submission for the given com.digitalasset.canton.ledger.participant.state.v2.ChangeId if one exists.
Retrieves the in-flight submission for the given com.digitalasset.canton.ledger.participant.state.v2.ChangeId if one exists.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def lookupEarliest(domainId: DomainId)(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]
Returns the earliest com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout or com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime in the store, if any, for the given domain.
Returns the earliest com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout or com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime in the store, if any, for the given domain.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def lookupSequencedUptoUnordered(domainId: DomainId, sequencingTimeInclusive: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[InFlightSubmission[SequencedSubmission]]]
Returns all sequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime is no later than
sequencingTimeInclusive
.Returns all sequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.sequencingTime is no later than
sequencingTimeInclusive
.The in-flight submissions are not returned in any specific order.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def lookupSomeMessageId(domainId: DomainId, messageId: MessageId)(implicit traceContext: TraceContext): Future[Option[InFlightSubmission[SubmissionSequencingInfo]]]
Returns one of the in-flight submissions with the given com.digitalasset.canton.topology.DomainId and com.digitalasset.canton.sequencing.protocol.MessageId, if any.
Returns one of the in-flight submissions with the given com.digitalasset.canton.topology.DomainId and com.digitalasset.canton.sequencing.protocol.MessageId, if any.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def lookupUnsequencedUptoUnordered(domainId: DomainId, observedSequencingTime: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[InFlightSubmission[UnsequencedSubmission]]]
Returns all unsequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is no later than
observedSequencingTime
.Returns all unsequenced in-flight submissions on the given domain whose com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is no later than
observedSequencingTime
.The in-flight submissions are not returned in any specific order.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- 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
- def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]
Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.
Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.
Note: you should *not* invoke
success
on the returned promise but rather usetrySuccess
. The reason is that the call tosuccess
may fail in case of shutdown.- Definition Classes
- PromiseUnlessShutdownFactory
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- 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 observeSequencedRootHash(rootHash: RootHash, submission: SequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]
Moves the submission with the given com.digitalasset.canton.protocol.RootHash from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.
Moves the submission with the given com.digitalasset.canton.protocol.RootHash from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.
If a com.digitalasset.canton.participant.protocol.submission.SequencedSubmission with the given com.digitalasset.canton.protocol.RootHash already exists:
- if the given submission was sequenced earlier than the existing one, it replaces it;
- otherwise, this call will be ignored.
As this method is called from the asynchronous part of message processing, this behavior ensures that the in-flight submission tracker always ends up tracking the earliest request for a given com.digitalasset.canton.protocol.RootHash, independently of the order in which these calls are made, in accordance with the replay prevention mechanism.
If the later request writes first, the InFlightSubmissionStore contains stale data for the submission request until the earlier request updates the row. This is fine because the stale information will only be read by the com.digitalasset.canton.participant.protocol.submission.InFlightSubmissionTracker after the corresponding completion event has been published by the com.digitalasset.canton.participant.event.RecordOrderPublisher. However, this happens only after the earlier request has signalled its tick, i.e., when Phase 3 has finished (via the com.digitalasset.canton.participant.protocol.Phase37Synchronizer and either a com.digitalasset.canton.protocol.messages.MediatorResult has been processed or the decision time has elapsed. By this time, the row with the stale data has been overwritten by the earlier request.
Calls to this method also race with calls to observeSequencing for later messages, e.g., if a submission request gets preplayed without a message ID. The argument about the stale data being benign also applies to those races. There are no races between several calls to observeSequencing because observeSequencing is called sequentially for each batch of sequenced events.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def observeSequencing(domainId: DomainId, submissions: Map[MessageId, SequencedSubmission])(implicit traceContext: TraceContext): Future[Unit]
Moves the submissions to the given domain with the given com.digitalasset.canton.sequencing.protocol.MessageIds from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.
Moves the submissions to the given domain with the given com.digitalasset.canton.sequencing.protocol.MessageIds from com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission to com.digitalasset.canton.participant.protocol.submission.SequencedSubmission.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- 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
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
- 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 afterf
completes, 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.close
as 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
- PerformUnlessClosing
- 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
- 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. Bothetf
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 afteretf
completes, 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.close
as part ofetf
, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- 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 afterf
completes, 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.close
as 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
- PerformUnlessClosing
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def register(submission: InFlightSubmission[UnsequencedSubmission]): EitherT[FutureUnlessShutdown, InFlightSubmission[SubmissionSequencingInfo], Unit]
Registers the given submission as being in flight and unsequenced unless there already is an in-flight submission for the same change ID.
Registers the given submission as being in flight and unsequenced unless there already is an in-flight submission for the same change ID.
This method MUST NOT run concurrently with a delete query for the same change ID and message ID. When this method fails with an exception, it is unknown whether the submission was registered.
- returns
A scala.Left$ of the existing in-flight submission with the same change ID and a different com.digitalasset.canton.sequencing.protocol.MessageId if there is any.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- 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
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- val storage: DbStorage
- Attributes
- protected
- Definition Classes
- DbInFlightSubmissionStore → DbStore
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbInFlightSubmissionStore → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateRegistration(submission: InFlightSubmission[UnsequencedSubmission], rootHash: RootHash)(implicit traceContext: TraceContext): Future[Unit]
Updates the registration of the given unsequenced submission with its root hash information.
Updates the registration of the given unsequenced submission with its root hash information.
If the root hash for the given submission has already been set by a previous call to this method, the new update will be ignored. If the given submission is not found in the store, the update will be ignored. We don't report an error because it can happen e.g. if the max sequencing time has already elapsed and the timely rejection published.
This is done as a separate operation from register because the root hash is currently not known at registration time.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- def updateUnsequenced(changeIdHash: ChangeIdHash, submissionDomain: DomainId, messageId: MessageId, newSequencingInfo: UnsequencedSubmission)(implicit traceContext: TraceContext): Future[Unit]
Update the in-flight submission identified by the given
changeId
ifsubmissionDomain
andmessageId
match and it is unsequenced and the existing com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is not earlier than thenewSequencingInfo
's com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout.Update the in-flight submission identified by the given
changeId
ifsubmissionDomain
andmessageId
match and it is unsequenced and the existing com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout is not earlier than thenewSequencingInfo
's com.digitalasset.canton.participant.protocol.submission.UnsequencedSubmission.timeout. Only the field com.digitalasset.canton.participant.protocol.submission.InFlightSubmission.sequencingInfo is updated.This is useful to change when and how a rejection is reported, e.g., if the submission logic decided to not send the com.digitalasset.canton.sequencing.protocol.SubmissionRequest to the sequencer after all.
- Definition Classes
- DbInFlightSubmissionStore → InFlightSubmissionStore
- 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])