com.digitalasset.canton.participant.event
RecordOrderPublisher
Companion object RecordOrderPublisher
class RecordOrderPublisher extends NamedLogging with FlagCloseableAsync
Publishes upstream events and active contract set changes in the order of their record time.
The protocol processors emit events and active contract set changes in the result message order, which differs from the record time (= sequencing time) order. The RecordOrderPublisher pushes the events to store.SingleDimensionEventLog and the active contract set changes (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 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.
- Alphabetic
- By Inheritance
- RecordOrderPublisher
- FlagCloseableAsync
- FlagCloseable
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RecordOrderPublisher(domainId: DomainId, initSc: SequencerCounter, initTimestamp: CantonTimestamp, eventLog: SingleDimensionEventLog[DomainEventLogId], multiDomainEventLog: MultiDomainEventLog, singleDomainCausalTracker: SingleDomainCausalTracker, inFlightSubmissionTracker: InFlightSubmissionTracker, metrics: TaskSchedulerMetrics, timeouts: ProcessingTimeout, useCausalityTracking: Boolean, loggerFactory: NamedLoggerFactory)(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
- eventLog
The event log to publish the events to
- metrics
The task scheduler metrics
- executionContextForPublishing
Execution context for publishing the events
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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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 → AutoCloseable
- Annotations
- @SuppressWarnings()
- 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
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val executionContextForPublishing: ExecutionContext
- def flush(): Future[Unit]
The returned future completes after all events that are currently scheduled for publishing have been published.
The returned future completes after all events that are currently scheduled for publishing have been published.
- Annotations
- @VisibleForTesting()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- FlagCloseable
- 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
- FlagCloseable
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- RecordOrderPublisher → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def onClosed(): Unit
- Definition Classes
- FlagCloseableAsync → FlagCloseable
- def performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, 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.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherT[E, R](onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, 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.- etf
The task to perform
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, 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.- 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
- FlagCloseable
- def readSequencerCounterQueue(sequencerCounter: SequencerCounter): AssociatedValue[CantonTimestamp]
Used to inspect the state of the sequencerCounterQueue, for testing purposes.
Used to inspect the state of the sequencerCounterQueue, for testing purposes.
- Annotations
- @VisibleForTesting()
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def scheduleAcsChangePublication(recordSequencerCounter: SequencerCounter, timestamp: CantonTimestamp, requestCounterO: Option[RequestCounter], acsChange: AcsChange)(implicit traceContext: TraceContext): Unit
- def scheduleEmptyAcsChangePublication(sequencerCounter: SequencerCounter, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Unit
Schedules an empty acs change publication task to be published to the
acsChangeListener. - def schedulePublication(requestSequencerCounter: SequencerCounter, requestCounter: RequestCounter, requestTimestamp: CantonTimestamp, eventO: Option[TimestampedEvent], updateO: Option[CausalityUpdate])(implicit traceContext: TraceContext): Future[Unit]
Schedules the given
eventto be published on theeventLog, and schedules the causal "tick" defined byclock.Schedules the given
eventto be published on theeventLog, and schedules the causal "tick" defined byclock.- requestSequencerCounter
The sequencer counter associated with the message that corresponds to the request
- eventO
The timestamped event to be published
- def scheduleRecoveries(toRecover: Seq[PendingPublish])(implicit traceContext: TraceContext): Unit
- def setAcsChangeListener(listener: AcsChangeListener): Unit
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tick(sequencerCounter: SequencerCounter, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Unit
Signals the progression of time to the record order publisher
Signals the progression of time to the record order publisher
- See also
TaskScheduler.addTick for the behaviour.
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- RecordOrderPublisher → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])