com.digitalasset.canton.participant.protocol
TransactionProcessor
Companion object TransactionProcessor
class TransactionProcessor extends ProtocolProcessor[SubmissionParam, TransactionSubmissionResult, TransactionViewType, TransactionSubmissionError]
- Alphabetic
- By Inheritance
- TransactionProcessor
- ProtocolProcessor
- Phase37Processor
- AbstractMessageProcessor
- HasCloseContext
- PromiseUnlessShutdownFactory
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TransactionProcessor(participantId: ParticipantId, confirmationRequestFactory: TransactionConfirmationRequestFactory, synchronizerId: PhysicalSynchronizerId, damle: DAMLe, staticSynchronizerParameters: StaticSynchronizerParameters, crypto: SynchronizerCryptoClient, sequencerClient: SequencerClient, inFlightSubmissionSynchronizerTracker: InFlightSubmissionSynchronizerTracker, ephemeral: SyncEphemeralState, commandProgressTracker: CommandProgressTracker, metrics: TransactionProcessingMetrics, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, packageResolver: PackageResolver, testingConfig: TestingConfigInternal, promiseFactory: PromiseUnlessShutdownFactory)(implicit ec: ExecutionContext)
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
- def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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
- implicit val ec: ExecutionContext
- 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
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def invalidRequest(requestCounter: RequestCounter, sequencerCounter: SequencerCounter, timestamp: CantonTimestamp, eventO: Option[SequencedUpdate])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
Transition the request to Clean without doing anything
Transition the request to Clean without doing anything
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def isCleanReplay(requestCounter: RequestCounter): Boolean
A clean replay replays a request whose request counter is below the clean head in the request journal.
A clean replay replays a request whose request counter is below the clean head in the request journal. Since the replayed request is clean, its effects are not persisted.
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosing
and friends.- Definition Classes
- OnShutdownRunner → HasUnlessClosing
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfReaderCallStack: Boolean
Set this to true to get detailed information about all futures that did not complete during shutdown.
Set this to true to get detailed information about all futures that did not complete during shutdown.
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- TransactionProcessor → ProtocolProcessor → NamedLogging
- def metricsContextForSubmissionParam(submissionParam: SubmissionParam): MetricsContext
- Attributes
- protected
- Definition Classes
- TransactionProcessor → ProtocolProcessor
- def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): 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
- def nameInternal: String
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- 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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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
- val participantId: ParticipantId
- Definition Classes
- TransactionProcessor → ProtocolProcessor
- def prepareForMediatorResultOfBadRequest(requestCounter: RequestCounter, sequencerCounter: SequencerCounter, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
Immediately moves the request to Confirmed and register a timeout handler at the decision time with the request tracker to cover the case that the mediator does not send a confirmation result.
Immediately moves the request to Confirmed and register a timeout handler at the decision time with the request tracker to cover the case that the mediator does not send a confirmation result.
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def processRequest(ts: CantonTimestamp, rc: RequestCounter, sc: SequencerCounter, batch: RequestBatch)(implicit traceContext: TraceContext): HandlerResult
Processes a request (Phase 3) and sends the response to the mediator if appropriate.
Processes a request (Phase 3) and sends the response to the mediator if appropriate.
- ts
The timestamp on the request
- rc
The request counter of the request
- sc
The sequencer counter of the request
- batch
The batch in the request
- returns
The returned future completes when request has reached the confirmed state and the response has been sent, or if an error aborts processing.
- Definition Classes
- ProtocolProcessor → Phase37Processor
- def processResult(counter: SequencerCounter, event: WithOpeningErrors[SignedContent[Deliver[DefaultOpenEnvelope]]])(implicit traceContext: TraceContext): HandlerResult
Processes a result message, commits the changes or rolls them back and emits events via the com.digitalasset.canton.participant.event.RecordOrderPublisher.
Processes a result message, commits the changes or rolls them back and emits events via the com.digitalasset.canton.participant.event.RecordOrderPublisher.
- event
The signed result batch to process. The batch must contain exactly one message.
- returns
The com.digitalasset.canton.sequencing.HandlerResult completes when the request has reached the state com.digitalasset.canton.participant.protocol.RequestJournal.RequestState.Clean and the event has been sent to the com.digitalasset.canton.participant.event.RecordOrderPublisher, or if the processing aborts with an error.
- Definition Classes
- ProtocolProcessor → Phase37Processor
- def remainingReaders(): Seq[String]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def removeReader(handle: ReaderHandle): Unit
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]
Schedules the given task to be run upon closing.
Schedules the given task to be run upon closing.
- returns
An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the
LifeCycleManager
'scloseAsync
method completes or whenAutoCloseable
'sclose
method returns, unless the returnedLifeCycleRegistrationHandle
was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the
LifeCycleManager
'scloseAsync
method completes orAutoCloseable
'sclose
returns. This is because the task is run immediately if the component has already been closed.- Definition Classes
- HasRunOnClosing
- final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
- HasRunOnClosing
- def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
- protected[this]
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def sendResponses(requestId: RequestId, messages: Seq[(ProtocolMessage, Recipients)], messageId: Option[MessageId] = None)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def signResponses(ips: SynchronizerSnapshotSyncCryptoApi, responses: ConfirmationResponses)(implicit traceContext: TraceContext): FutureUnlessShutdown[SignedProtocolMessage[ConfirmationResponses]]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def submit(submitterInfo: SubmitterInfo, transactionMeta: TransactionMeta, keyResolver: LfKeyResolver, transaction: WellFormedTransaction[WithoutSuffixes], disclosedContracts: Map[LfContractId, ContractInstance], topologySnapshot: TopologySnapshot)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TransactionSubmissionError, FutureUnlessShutdown[TransactionSubmissionResult]]
- def submit(submissionParam: SubmissionParam, topologySnapshot: TopologySnapshot)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TransactionSubmissionError, FutureUnlessShutdown[TransactionSubmissionResult]]
Submits the request to the sequencer, using a recent topology snapshot and the current persisted state as an approximation to the future state at the assigned request timestamp.
Submits the request to the sequencer, using a recent topology snapshot and the current persisted state as an approximation to the future state at the assigned request timestamp.
- submissionParam
The bundled submission parameters
- topologySnapshot
A recent topology snapshot
- returns
The submission error or a future with the submission result. With submission tracking, the outer future completes after the submission is registered as in-flight, and the inner future after the submission has been sequenced or if it will never be sequenced. Without submission tracking, both futures complete after the submission has been sequenced or if it will not be sequenced.
- Definition Classes
- ProtocolProcessor
- def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run. Otherwise it is the result of runningf
.
- Definition Classes
- HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s.Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
- PerformUnlessClosing
- def synchronizeWithClosingPatience: FiniteDuration
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has finished or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run.
- Definition Classes
- HasSynchronizeWithClosing
- Annotations
- @SuppressWarnings()
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
f
only if the component is not yet closing.Runs the computation
f
only if the component is not yet closing. If so, the component will delay releasing its resources untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as part off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
f
has not run. Otherwise the result of runningf
.
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def terminateRequest(requestCounter: RequestCounter, requestSequencerCounter: SequencerCounter, requestTimestamp: CantonTimestamp, commitTime: CantonTimestamp, eventO: Option[SequencedUpdate])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- val testingConfig: TestingConfigInternal
- Definition Classes
- TransactionProcessor → ProtocolProcessor
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- TransactionProcessor → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unlessCleanReplay(requestCounter: RequestCounter)(f: => FutureUnlessShutdown[_]): FutureUnlessShutdown[Unit]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fa
unless isClosing returns true.Runs the computation
fa
unless isClosing returns true.This method does not delay the closing while
fa
is running, unlike the methods inHasSynchronizeWithClosing
. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
The result of
fa
or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
- HasUnlessClosing
- Annotations
- @inline()
- 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])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders