class Phase37Synchronizer extends NamedLogging

Synchronizes the request processing of phases 3 and 7. At the end of phase 3, every request must signal that it has reached com.digitalasset.canton.participant.protocol.RequestJournal.RequestState.Confirmed via markConfirmed or markTimeout. At the beginning of phase 7, requests can wait on the completion of phase 3 via awaitConfirmed.

Eventually, all requests should either end with a RequestState.ValidatedAndCompleted. After this point the request is cleaned from memory. Otherwise, the synchronizer becomes a memory leak. This class assumes that the timestamps in request IDs grow strictly with the non-skipped request counters.

Linear Supertypes
NamedLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Phase37Synchronizer
  2. NamedLogging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Phase37Synchronizer(initRc: RequestCounter, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor)

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 awaitConfirmed[T <: PendingRequestData](requestId: RequestId, filter: (PendingRequestDataOrReplayData[T]) => Future[Boolean] = (_: PendingRequestDataOrReplayData[T]) => Future.successful(true))(implicit traceContext: TraceContext, ec: ExecutionContext): Future[Option[PendingRequestDataOrReplayData[T]]]

    The returned future completes with either the pending request data, if it's the first valid call, or None otherwise.

    The returned future completes with either the pending request data, if it's the first valid call, or None otherwise. Please note that for each request only the first awaitConfirmed, where filter == true, completes with the pending request data even if the filters are different.

    requestId

    The request id (timestamp) of the request to synchronize.

    filter

    A function that returns if a request is either valid or not (e.g. contains a valid signature). This filter can be different for each call of awaitConfirmed, but only the first valid filter will complete with the pending request data.

  6. def cleanOnTimeout(requestId: RequestId)(implicit traceContext: TraceContext): Unit

    Clean internal data after the request has been inserted with markTimeout.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  15. val loggerFactory: NamedLoggerFactory
    Definition Classes
    Phase37Synchronizer → NamedLogging
  16. def markConfirmed(requestType: RequestType)(requestCounter: RequestCounter, requestId: RequestId, decisionTime: CantonTimestamp, requestData: PendingRequestDataOrReplayData[PendingRequestData])(implicit traceContext: TraceContext, ec: ExecutionContext): Unit

    Marks the given request as having reached com.digitalasset.canton.participant.protocol.RequestJournal.RequestState.Confirmed.

    Marks the given request as having reached com.digitalasset.canton.participant.protocol.RequestJournal.RequestState.Confirmed.

    requestCounter

    The request counter of the request to synchronize.

    requestId

    The request id (timestamp) of the request to mark as confirmed.

    decisionTime

    The decision time for the request (timestamp + participant timeout + mediator timeout).

    requestData

    The data to return to the caller if the request if valid.

    Exceptions thrown

    • If the maximum request counter Long.MaxValue is used.
    • If the same request counter was marked with a different timestamp or skipped and not all requests since the initial request counter initRc have been marked as confirmed or skipped.
    • If the same request was marked with different requestData or indicated as timed out.
  17. def markTimeout(requestCounter: RequestCounter, requestId: RequestId, decisionTime: CantonTimestamp)(implicit traceContext: TraceContext, ec: ExecutionContext): Unit

    Marks the given request as having timeout.

    Marks the given request as having timeout.

    requestCounter

    The request counter of the request to synchronize.

    requestId

    The request id (timestamp) of the request to mark as timeout.

    decisionTime

    The decision time for the request (timestamp + participant timeout + mediator timeout).

    Exceptions thrown

    • If the maximum request counter Long.MaxValue is used
    • If the same request counter was marked with a different timestamp or skipped and not all requests since the initial request counter initRc have been marked as confirmed or skipped.
    • If the same request was marked as confirmed.
  18. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def skipRequestCounter(requestCounter: RequestCounter, requestId: RequestId)(implicit traceContext: TraceContext): Unit

    Skips the given request counter without specifying a timestamp.

    Skips the given request counter without specifying a timestamp.

    Exceptions thrown

    • If the maximum request counter Long.MaxValue is used
    • If the same request counter was marked as confirmed and not all requests since the initial request counter initRc have been marked as confirmed or skipped.
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. 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

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped