class MediatorPruningScheduler extends EnterpriseScheduler with HasCloseContext with PruningScheduler with HasPruningSchedulerStore with UpdatePruningMetric
- Alphabetic
- By Inheritance
- MediatorPruningScheduler
- UpdatePruningMetric
- HasPruningSchedulerStore
- FlagCloseable
- PruningScheduler
- HasCloseContext
- EnterpriseScheduler
- NamedLogging
- Scheduler
- AutoCloseable
- StartStoppable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MediatorPruningScheduler(clock: Clock, mediator: Mediator, storage: Storage, config: MediatorPruningConfig, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
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 clearSchedule()(implicit traceContext: TraceContext): Future[Unit]
- Definition Classes
- HasPruningSchedulerStore → Scheduler
- 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()
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def deactivate()(implicit traceContext: TraceContext): Unit
- Attributes
- protected
- Definition Classes
- EnterpriseScheduler
- implicit val ec: ExecutionContext
- Definition Classes
- EnterpriseScheduler
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getScheduleWithRetention()(implicit traceContext: TraceContext): Future[Option[PruningSchedule]]
- Definition Classes
- HasPruningSchedulerStore → PruningScheduler
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def initializeSchedule()(implicit traceContext: TraceContext): Future[Option[EnterpriseSchedule]]
Hook to create and initialize the schedule when scheduler becomes active
Hook to create and initialize the schedule when scheduler becomes active
- returns
if override returns Some[A] go ahead and schedule; if None don't
- Definition Classes
- MediatorPruningScheduler → EnterpriseScheduler
- def internalPerformUnlessClosingF[A](name: String)(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 isScheduleActivated: Boolean
- Attributes
- protected
- Definition Classes
- EnterpriseScheduler
- 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
- Definition Classes
- EnterpriseScheduler → NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- 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()
- def onClosed(): Unit
- Definition Classes
- MediatorPruningScheduler → HasPruningSchedulerStore → FlagCloseable
- def performUnlessClosing[A](name: String)(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.DO NOT CALL
this.closeas part off, 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
- FlagCloseable
- 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
- FlagCloseable
- 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
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.DO NOT CALL
this.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- FlagCloseable
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](name: String)(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.DO NOT CALL
this.closeas part off, 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
- FlagCloseable
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- FlagCloseable
- val pruningSchedulerStore: PruningSchedulerStore
- Attributes
- protected
- Definition Classes
- MediatorPruningScheduler → HasPruningSchedulerStore
- def reactivateSchedulerIfActive()(implicit traceContext: TraceContext): Future[Unit]
- Definition Classes
- EnterpriseScheduler
- def reactivateSchedulerIfActiveET()(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- Definition Classes
- EnterpriseScheduler
- def restart()(implicit traceContext: TraceContext): Future[Unit]
Convenience method for restart
Convenience method for restart
- Definition Classes
- StartStoppable
- 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
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def schedulerJob(schedule: IndividualSchedule)(implicit traceContext: TraceContext): Future[ScheduledRunResult]
Implements the code that is to be executed when the scheduled time has arrived for the duration of the "maxDuration".
Implements the code that is to be executed when the scheduled time has arrived for the duration of the "maxDuration". Within a single such "window" schedulerJob will be called until "Done" is returned as a result the first time.
As guidance long running logic should be broken up into "chunks" expected to run at most for 1 minute although in the face of unpredictable database performance this is a "best effort". Tasks may exceed the "maxDuration" window by however long they take to execute.
- schedule
the specific schedule among the potentially multiple schedulers that triggered this particular job run. Useful for callees to extract additional information (such as retention for pruning) or to determine the type of work scheduled (e.g. pruning versus pruning metric update).
- Definition Classes
- MediatorPruningScheduler → EnterpriseScheduler
- def setScheduleWithRetention(schedule: PruningSchedule)(implicit traceContext: TraceContext): Future[Unit]
- Definition Classes
- HasPruningSchedulerStore → PruningScheduler
- def start()(implicit traceContext: TraceContext): Future[Unit]
Start scheduler(s).
Start scheduler(s).
- Definition Classes
- EnterpriseScheduler → StartStoppable
- def stop()(implicit traceContext: TraceContext): Unit
Stop scheduler(s).
Stop scheduler(s).
- Definition Classes
- EnterpriseScheduler → StartStoppable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Definition Classes
- MediatorPruningScheduler → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateCron(cron: Cron)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- Definition Classes
- HasPruningSchedulerStore → Scheduler
- def updateMaxDuration(maxDuration: PositiveSeconds)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- Definition Classes
- HasPruningSchedulerStore → Scheduler
- def updateRetention(retention: PositiveSeconds)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
Updates the pruning retention, i.e.
Updates the pruning retention, i.e. the age of the newest piece of data to be pruned relative to the node's clock.
- retention
retention as a duration
- Definition Classes
- HasPruningSchedulerStore → PruningScheduler
- def updateScheduleAndReactivateIfActive(update: => Future[Unit])(implicit traceContext: TraceContext): Future[Unit]
- Definition Classes
- EnterpriseScheduler
- 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])
- def withUpdatePruningMetric(schedule: IndividualSchedule, updateMetric: => Future[Unit])(code: (PruningCronSchedule) => Future[ScheduledRunResult])(implicit executionContext: ExecutionContext): Future[ScheduledRunResult]
- Definition Classes
- UpdatePruningMetric
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable