c

com.digitalasset.canton.domain.mediator

MediatorPruningScheduler

class MediatorPruningScheduler extends EnterpriseScheduler with HasCloseContext with PruningScheduler with HasPruningSchedulerStore with UpdatePruningMetric

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MediatorPruningScheduler
  2. UpdatePruningMetric
  3. HasPruningSchedulerStore
  4. FlagCloseable
  5. PerformUnlessClosing
  6. OnShutdownRunner
  7. PruningScheduler
  8. HasCloseContext
  9. PromiseUnlessShutdownFactory
  10. EnterpriseScheduler
  11. NamedLogging
  12. Scheduler
  13. AutoCloseable
  14. StartStoppable
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MediatorPruningScheduler(clock: Clock, mediator: Mediator, storage: Storage, config: MediatorPruningConfig, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  6. def clearSchedule()(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    HasPruningSchedulerStoreScheduler
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. 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
  9. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  11. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  12. def deactivate()(implicit traceContext: TraceContext): Unit
    Attributes
    protected
    Definition Classes
    EnterpriseScheduler
  13. implicit val ec: ExecutionContext
    Definition Classes
    EnterpriseScheduler
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def getSchedule()(implicit traceContext: TraceContext): Future[Option[PruningSchedule]]
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. 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
    MediatorPruningSchedulerEnterpriseScheduler
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  22. 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
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isScheduleActivated: Boolean
    Attributes
    protected
    Definition Classes
    EnterpriseScheduler
  25. 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
    PerformUnlessClosing
  26. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. val loggerFactory: NamedLoggerFactory
    Definition Classes
    EnterpriseSchedulerNamedLogging
  28. 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
  29. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): 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
  30. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  35. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  36. def onClosed(): Unit
  37. 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
    Annotations
    @SuppressWarnings()
  38. 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.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    PerformUnlessClosing
  39. 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
  40. 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.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  41. 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
    PerformUnlessClosing
  42. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  44. 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.

    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
  45. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  46. val pruningSchedulerStore: PruningSchedulerStore
    Attributes
    protected
    Definition Classes
    MediatorPruningSchedulerHasPruningSchedulerStore
  47. def reactivateSchedulerIfActive()(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    EnterpriseScheduler
  48. def reactivateSchedulerIfActiveET()(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Definition Classes
    EnterpriseScheduler
  49. def restart()(implicit traceContext: TraceContext): Future[Unit]

    Convenience method for restart

    Convenience method for restart

    Definition Classes
    StartStoppable
  50. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  51. 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
    OnShutdownRunner
  52. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  53. 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
    MediatorPruningSchedulerEnterpriseScheduler
  54. def setSchedule(schedule: PruningSchedule)(implicit traceContext: TraceContext): Future[Unit]
  55. def start()(implicit traceContext: TraceContext): Future[Unit]

    Start scheduler(s).

    Start scheduler(s).

    Definition Classes
    EnterpriseSchedulerStartStoppable
  56. def stop()(implicit traceContext: TraceContext): Unit

    Stop scheduler(s).

    Stop scheduler(s).

    Definition Classes
    EnterpriseSchedulerStartStoppable
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. val timeouts: ProcessingTimeout
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. def updateCron(cron: Cron)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Definition Classes
    HasPruningSchedulerStoreScheduler
  61. def updateMaxDuration(maxDuration: PositiveSeconds)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Definition Classes
    HasPruningSchedulerStoreScheduler
  62. 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
    HasPruningSchedulerStorePruningScheduler
  63. def updateScheduleAndReactivateIfActive(update: => Future[Unit])(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    EnterpriseScheduler
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. def withUpdatePruningMetric(schedule: IndividualSchedule, updateMetric: => Future[Unit])(code: (PruningCronSchedule) => Future[ScheduledRunResult])(implicit executionContext: ExecutionContext): Future[ScheduledRunResult]
    Definition Classes
    UpdatePruningMetric

Deprecated Value Members

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

Inherited from UpdatePruningMetric

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from PruningScheduler

Inherited from HasCloseContext

Inherited from EnterpriseScheduler

Inherited from NamedLogging

Inherited from Scheduler

Inherited from AutoCloseable

Inherited from StartStoppable

Inherited from AnyRef

Inherited from Any

Ungrouped