class AssignmentProcessor extends ProtocolProcessor[SubmissionParam, SubmissionResult, AssignmentViewType, ReassignmentProcessorError]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AssignmentProcessor
  2. ProtocolProcessor
  3. Phase37Processor
  4. AbstractMessageProcessor
  5. HasCloseContext
  6. PromiseUnlessShutdownFactory
  7. FlagCloseable
  8. PerformUnlessClosing
  9. HasSynchronizeWithReaders
  10. HasSynchronizeWithClosing
  11. OnShutdownRunner
  12. HasRunOnClosing
  13. HasUnlessClosing
  14. AutoCloseable
  15. NamedLogging
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AssignmentProcessor(synchronizerId: Target[PhysicalSynchronizerId], participantId: ParticipantId, staticSynchronizerParameters: Target[StaticSynchronizerParameters], reassignmentCoordination: ReassignmentCoordination, inFlightSubmissionSynchronizerTracker: InFlightSubmissionSynchronizerTracker, ephemeral: SyncEphemeralState, synchronizerCrypto: SynchronizerCryptoClient, seedGenerator: SeedGenerator, sequencerClient: SequencerClient, timeouts: ProcessingTimeout, targetProtocolVersion: Target[ProtocolVersion], loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, testingConfig: TestingConfigInternal, promiseFactory: PromiseUnlessShutdownFactory)(implicit ec: ExecutionContext)

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. 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
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. 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
  16. 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
  17. 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
    OnShutdownRunnerHasUnlessClosing
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
    PerformUnlessClosingHasSynchronizeWithReaders
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ProtocolProcessorNamedLogging
  22. def metricsContextForSubmissionParam(submissionParam: SubmissionParam): MetricsContext
    Attributes
    protected
    Definition Classes
    AssignmentProcessorProtocolProcessor
  23. 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 use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  24. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  25. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  31. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. 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
  33. val participantId: ParticipantId
  34. 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
  35. 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
  36. 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
    ProtocolProcessorPhase37Processor
  37. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  38. 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
  39. 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's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle 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
    OnShutdownRunnerHasRunOnClosing
  40. 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's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  41. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  42. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  43. def sendResponses(requestId: RequestId, messages: Seq[(ProtocolMessage, Recipients)], messageId: Option[MessageId] = None)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  44. def signResponses(ips: SynchronizerSnapshotSyncCryptoApi, responses: ConfirmationResponses)(implicit traceContext: TraceContext): FutureUnlessShutdown[SignedProtocolMessage[ConfirmationResponses]]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  45. def submit(submissionParam: SubmissionParam, topologySnapshot: TopologySnapshot)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, ReassignmentProcessorError, 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

    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
  46. 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 until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  47. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  48. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  49. 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 until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  50. 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 until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  51. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def terminateRequest(requestCounter: RequestCounter, requestSequencerCounter: SequencerCounter, requestTimestamp: CantonTimestamp, commitTime: CantonTimestamp, eventO: Option[SequencedUpdate])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  54. val testingConfig: TestingConfigInternal
  55. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    AssignmentProcessorFlagCloseable
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. def unlessCleanReplay(requestCounter: RequestCounter)(f: => FutureUnlessShutdown[_]): FutureUnlessShutdown[Unit]
    Attributes
    protected
    Definition Classes
    AbstractMessageProcessor
  58. 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 in HasSynchronizeWithClosing. 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()
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Ungrouped