class TransferInProcessor extends ProtocolProcessor[SubmissionParam, SubmissionResult, TransferInViewType, TransferInResult, TransferProcessorError]
- Alphabetic
- By Inheritance
- TransferInProcessor
- ProtocolProcessor
- Phase37Processor
- AbstractMessageProcessor
- HasCloseContext
- PromiseUnlessShutdownFactory
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TransferInProcessor(domainId: TargetDomainId, participantId: ParticipantId, damle: DAMLe, staticDomainParameters: StaticDomainParameters, transferCoordination: TransferCoordination, inFlightSubmissionTracker: InFlightSubmissionTracker, ephemeral: SyncDomainEphemeralState, domainCrypto: DomainSyncCryptoClient, seedGenerator: SeedGenerator, sequencerClient: SequencerClient, timeouts: ProcessingTimeout, targetProtocolVersion: TargetProtocolVersion, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, skipRecipientsCheck: Boolean)(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
- 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() @IntrinsicCandidate()
- 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
- 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() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def invalidRequest(requestCounter: RequestCounter, sequencerCounter: SequencerCounter, timestamp: CantonTimestamp)(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
- 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
- ProtocolProcessor → NamedLogging
- 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() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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()
- val participantId: ParticipantId
- Definition Classes
- TransferInProcessor → ProtocolProcessor
- 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 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 mediator 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 mediator result.
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def processMalformedMediatorRequestResult(timestamp: CantonTimestamp, sequencerCounter: SequencerCounter, signedResultBatch: Either[EventWithErrors[Deliver[DefaultOpenEnvelope]], SignedContent[Deliver[DefaultOpenEnvelope]]])(implicit traceContext: TraceContext): HandlerResult
- Definition Classes
- ProtocolProcessor → Phase37Processor
- 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(signedResultBatchE: Either[EventWithErrors[Deliver[DefaultOpenEnvelope]], 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.
- signedResultBatchE
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 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()
- def sendResponses(requestId: RequestId, rc: RequestCounter, messages: Seq[(ProtocolMessage, Recipients)], messageId: Option[MessageId] = None)(implicit traceContext: TraceContext): Future[Unit]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def signResponse(ips: DomainSnapshotSyncCryptoApi, response: MediatorResponse)(implicit traceContext: TraceContext): Future[SignedProtocolMessage[MediatorResponse]]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- def submit(submissionParam: SubmissionParam)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TransferProcessorError, FutureUnlessShutdown[SubmissionResult]]
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
- 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 submitWithTracking(submissionParam: SubmissionParam, tracked: TrackedSubmission)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TransferProcessorError, FutureUnlessShutdown[SubmissionResult]]
Register the submission as in-flight, deduplicate it, and submit it.
Register the submission as in-flight, deduplicate it, and submit it. Errors after the registration are reported asynchronously only and return a scala.Right$. This ensures that every submission generates at most one rejection reason, namely through the timely rejection mechanism. In-flight tracking may concurrently remove the submission at any time and publish the timely rejection event instead of the actual error.
- Definition Classes
- ProtocolProcessor
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def terminateRequest(requestCounter: RequestCounter, requestSequencerCounter: SequencerCounter, requestTimestamp: CantonTimestamp, commitTime: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- TransferInProcessor → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unlessCleanReplay(requestCounter: RequestCounter)(f: => Future[_]): Future[Unit]
- Attributes
- protected
- Definition Classes
- AbstractMessageProcessor
- 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])