abstract class ProtocolProcessor[SubmissionParam, SubmissionResult, RequestViewType <: ViewType, Result <: MediatorResult with SignedProtocolMessageContent, SubmissionError <: WrapsProcessorError] extends AbstractMessageProcessor with RequestProcessor[RequestViewType]

The ProtocolProcessor combines ProcessingSteps specific to a particular kind of request with the common processing steps and wires them up with the state updates and synchronization.

SubmissionParam

The bundled submission parameters

SubmissionResult

The bundled submission results

RequestViewType

The type of view trees used by the request

Result

The specific type of the result message

SubmissionError

The type of errors that occur during submission processing

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProtocolProcessor
  2. Phase37Processor
  3. AbstractMessageProcessor
  4. HasCloseContext
  5. PromiseUnlessShutdownFactory
  6. FlagCloseable
  7. PerformUnlessClosing
  8. OnShutdownRunner
  9. AutoCloseable
  10. NamedLogging
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ProtocolProcessor(steps: ProcessingSteps[SubmissionParam, SubmissionResult, RequestViewType, Result, SubmissionError], inFlightSubmissionTracker: InFlightSubmissionTracker, ephemeral: SyncDomainEphemeralState, crypto: DomainSyncCryptoClient, sequencerClient: SequencerClient, domainId: DomainId, protocolVersion: ProtocolVersion, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, skipRecipientsCheck: Boolean)(implicit ec: ExecutionContext, resultCast: SignedMessageContentCast[Result])

    steps

    The specific processing steps

Abstract Value Members

  1. abstract def participantId: ParticipantId
  2. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable

Concrete 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. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  10. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  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 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
  18. 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
  19. 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
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
  22. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ProtocolProcessorNamedLogging
  24. 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
  25. 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 use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  26. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  33. 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()
  34. 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
  35. 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
  36. 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
  37. 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
  38. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  39. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  40. 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
  41. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  42. 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
  43. def processMalformedMediatorRequestResult(timestamp: CantonTimestamp, sequencerCounter: SequencerCounter, signedResultBatch: Either[EventWithErrors[Deliver[DefaultOpenEnvelope]], SignedContent[Deliver[DefaultOpenEnvelope]]])(implicit traceContext: TraceContext): HandlerResult
    Definition Classes
    ProtocolProcessorPhase37Processor
  44. 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
    ProtocolProcessorPhase37Processor
  45. 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
    ProtocolProcessorPhase37Processor
  46. 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
  47. 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
  48. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  49. def sendResponses(requestId: RequestId, rc: RequestCounter, messages: Seq[(ProtocolMessage, Recipients)], messageId: Option[MessageId] = None)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  50. def signResponse(ips: DomainSnapshotSyncCryptoApi, response: MediatorResponse)(implicit traceContext: TraceContext): Future[SignedProtocolMessage[MediatorResponse]]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  51. def submit(submissionParam: SubmissionParam)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SubmissionError, 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.

  52. def submitWithTracking(submissionParam: SubmissionParam, tracked: TrackedSubmission)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SubmissionError, 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.

  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def terminateRequest(requestCounter: RequestCounter, requestSequencerCounter: SequencerCounter, requestTimestamp: CantonTimestamp, commitTime: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. def unlessCleanReplay(requestCounter: RequestCounter)(f: => Future[_]): Future[Unit]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. 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 HasCloseContext

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped