Packages

class RecordOrderPublisher extends PublishesOnlinePartyReplicationEvents with NamedLogging with FlagCloseableAsync with HasCloseContext with PromiseUnlessShutdownFactory

Publishes upstream events and active contract set changes in the order of their record time.

The protocol processors produce events and active contract set changes in the result message order in phase 7. The RecordOrderPublisher pushes the events to indexer and the active contract set changes in record time order (which equals sequencing time order). (including empty changes on time proofs) to the appropriate listener, which is normally pruning.AcsCommitmentProcessor. The events are published only after the com.digitalasset.canton.participant.protocol.submission.InFlightSubmissionTracker has observed the timestamp.

All sequencer counters above and including initSc must eventually be signalled to the RecordOrderPublisher using tick. An event is published only when all sequencer counters between initSc and its associated sequencer counter have been signalled.

Linear Supertypes
HasCloseContext, PromiseUnlessShutdownFactory, FlagCloseableAsync, FlagCloseable, PerformUnlessClosing, HasSynchronizeWithReaders, OnShutdownRunner, HasRunOnClosing, HasUnlessClosing, AutoCloseable, NamedLogging, PublishesOnlinePartyReplicationEvents, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordOrderPublisher
  2. HasCloseContext
  3. PromiseUnlessShutdownFactory
  4. FlagCloseableAsync
  5. FlagCloseable
  6. PerformUnlessClosing
  7. HasSynchronizeWithReaders
  8. OnShutdownRunner
  9. HasRunOnClosing
  10. HasUnlessClosing
  11. AutoCloseable
  12. NamedLogging
  13. PublishesOnlinePartyReplicationEvents
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RecordOrderPublisher(synchronizerId: SynchronizerId, initSc: SequencerCounter, initTimestamp: CantonTimestamp, ledgerApiIndexer: LedgerApiIndexer, metrics: TaskSchedulerMetrics, exitOnFatalFailures: Boolean, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, clock: Clock)(implicit executionContextForPublishing: ExecutionContext)

    initSc

    The initial sequencer counter from which on events should be published

    initTimestamp

    The initial timestamp from which on events should be published

    metrics

    The task scheduler metrics

    executionContextForPublishing

    Execution context for publishing the events

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
    FlagCloseable → OnShutdownRunner → AutoCloseable
  8. def closeAsync(): Seq[AsyncOrSyncCloseable]

    closeAsync asynchronously releases resources held by a future

    closeAsync asynchronously releases resources held by a future

    returns

    an ordered sequence of async and sync closeables with async closeables made up of future and timeout

    Definition Classes
    RecordOrderPublisher → FlagCloseableAsync
  9. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable → PerformUnlessClosing
  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. implicit val executionContextForPublishing: ExecutionContext
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. val initTimestamp: CantonTimestamp
  18. 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
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. 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
  21. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  22. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    RecordOrderPublisher → NamedLogging
  23. 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
  24. 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
  25. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosing → HasSynchronizeWithReaders
  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
    @IntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. final def onClosed(): Unit
    Definition Classes
    FlagCloseableAsync → 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
    PerformUnlessClosing → OnShutdownRunner
    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. DO NOT PUT retries, especially indefinite ones, inside f.

    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 performUnlessClosingCheckedUST[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[FutureUnlessShutdown, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[FutureUnlessShutdown, A, N, R]
    Definition Classes
    PerformUnlessClosing
  37. 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. DO NOT PUT retries, especially indefinite ones, inside f.

    etf

    The task to perform

    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 performUnlessClosingEitherUSFAsync[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(asyncResultToWaitForF: (R) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    etf

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by etf

    Definition Classes
    PerformUnlessClosing
  41. 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. DO NOT PUT retries, especially indefinite ones, inside f.

    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
  42. def performUnlessClosingOptionUSF[R](name: String)(otf: => OptionT[FutureUnlessShutdown, R])(implicit ec: ExecutionContext, traceContext: TraceContext): OptionT[FutureUnlessShutdown, R]
    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  44. def performUnlessClosingUSFAsync[A](name: String)(f: => FutureUnlessShutdown[A])(asyncResultToWaitForF: (A) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    f

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by f

    Definition Classes
    PerformUnlessClosing
  45. def publishBufferedEvents()(implicit traceContext: TraceContext): UnlessShutdown[Unit]

    Schedules flushing of events that were buffered during Online Party Replication as soon as possible.

    Schedules flushing of events that were buffered during Online Party Replication as soon as possible.

    Meant to be called once Online Party Replication has succeeded.

    Definition Classes
    RecordOrderPublisher → PublishesOnlinePartyReplicationEvents
  46. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  47. 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
  48. 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
    OnShutdownRunner → HasRunOnClosing
  49. 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
  50. 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
  51. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunner → HasRunOnClosing
  52. def scheduleEmptyAcsChangePublication(sequencerCounter: SequencerCounter, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): UnlessShutdown[Unit]

    Schedules an empty acs change publication task to be published to the acsChangeListener.

  53. def scheduleEventBuffering(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): UnlessShutdown[Either[CantonTimestamp, Unit]]

    Schedules the beginning of buffering of Ledger API Indexer event publishing for Online Party Replication.

    Schedules the beginning of buffering of Ledger API Indexer event publishing for Online Party Replication.

    Meant to be scheduled when the PartyToParticipant topology transaction adds a new participant to an existing party.

  54. def scheduleFloatingEventPublication(timestamp: CantonTimestamp, eventFactory: (CantonTimestamp) => Option[FloatingUpdate])(implicit traceContext: TraceContext): UnlessShutdown[Either[CantonTimestamp, Unit]]

    Schedule a floating event, if the current synchronizer time is earlier than timestamp.

    Schedule a floating event, if the current synchronizer time is earlier than timestamp.

    timestamp

    The desired timestamp of the publication: if cannot be met, the function will return a Left.

    eventFactory

    A function returning an optional Update to be published. This function will be executed as the scheduled task is executing. (if scheduling is possible) This function will be called with timestamp.

    traceContext

    Should be the TraceContext of the event

    returns

    A Left with the current synchronizer time, if scheduling is not possible as the synchronizer time is bigger. A Right with unit if possible.

  55. def scheduleFloatingEventPublication[T](timestamp: CantonTimestamp, eventFactory: (CantonTimestamp) => Option[FloatingUpdate], onScheduled: () => FutureUnlessShutdown[T])(implicit traceContext: TraceContext): UnlessShutdown[Either[CantonTimestamp, FutureUnlessShutdown[T]]]

    Schedule a floating event, if the current synchronizer time is earlier than timestamp.

    Schedule a floating event, if the current synchronizer time is earlier than timestamp.

    timestamp

    The desired timestamp of the publication: if cannot be met, the function will return a Left.

    eventFactory

    A function returning an optional Update to be published. This function will be executed as the scheduled task is executing. (if scheduling is possible) This function will be called with timestamp.

    onScheduled

    A function creating a FutureUnlessShutdown[T]. This function will be only executed, if the scheduling is possible. This function will be executed before the scheduleFloatingEventPublication returns. (if scheduling is possible) Execution of the floating event publication will wait for the onScheduled operation to finish.

    traceContext

    Should be the TraceContext of the event

    returns

    A Left with the current synchronizer time, if scheduling is not possible as the synchronizer time is bigger. A Right with the result of the onScheduled FutureUnlessShutdown[T].

  56. def scheduleFloatingEventPublicationImmediately(eventFactory: (CantonTimestamp) => Option[FloatingUpdate])(implicit traceContext: TraceContext): UnlessShutdown[CantonTimestamp]

    Schedule a floating event immediately: with the synchronizer time of the last published event.

    Schedule a floating event immediately: with the synchronizer time of the last published event.

    eventFactory

    A function returning an optional Update to be published. This function will be executed as the scheduled task is executing. This function will be called with the realized synchronizer timestamp.

    traceContext

    Should be the TraceContext of the event

    returns

    The timestamp used for the publication.

  57. def schedulePublishAddContracts(buildEventAtRecordTime: (CantonTimestamp) => NonEmpty[Seq[Update]])(implicit traceContext: TraceContext): UnlessShutdown[Unit]

    Schedules publishing of an Online Party Replication ACS chunk as soon as possible.

    Schedules publishing of an Online Party Replication ACS chunk as soon as possible.

    Meant to be called only between enclosing scheduleEventBuffering and publishBufferedEvents calls.

    Definition Classes
    RecordOrderPublisher → PublishesOnlinePartyReplicationEvents
  58. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosing → HasSynchronizeWithReaders
  59. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  60. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  61. def tick(event: SequencedUpdate, sequencerCounter: SequencerCounter, rcO: Option[RequestCounter])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Schedules the given eventO to be published on the eventLog, and schedules the causal "tick" defined by clock.

    Schedules the given eventO to be published on the eventLog, and schedules the causal "tick" defined by clock. Tick must be called exactly once for all sequencer counters higher than initTimestamp.

    event

    The update event to be published.

    sequencerCounter

    The SequencerCounter of the sequenced event which resulted in this event

    rcO

    The optional request counter for logging as RCs are more human-readable than timestamps.

  62. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    RecordOrderPublisher → FlagCloseable
  63. def toString(): String
    Definition Classes
    AnyRef → Any
  64. 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()
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. 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)

Inherited from HasCloseContext

Inherited from PromiseUnlessShutdownFactory

Inherited from FlagCloseableAsync

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from HasSynchronizeWithReaders

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from PublishesOnlinePartyReplicationEvents

Inherited from AnyRef

Inherited from Any

Ungrouped