Packages

class LightArrayRevolverScheduler extends Scheduler with Closeable

This scheduler implementation is based on a revolving wheel of buckets, like Netty’s HashedWheelTimer, which it advances at a fixed tick rate and dispatches tasks it finds in the current bucket to their respective ExecutionContexts. The tasks are held in TaskHolders, which upon cancellation null out their reference to the actual task, leaving only this shell to be cleaned up when the wheel reaches that bucket next time. This enables the use of a simple linked list to chain the TaskHolders off the wheel.

Also noteworthy is that this scheduler does not obtain a current time stamp when scheduling single-shot tasks, instead it always rounds up the task delay to a full multiple of the TickDuration. This means that tasks are scheduled possibly one tick later than they could be (if checking that “now() + delay <= nextTick” were done).

Source
LightArrayRevolverScheduler.scala
Linear Supertypes
Closeable, AutoCloseable, Scheduler, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightArrayRevolverScheduler
  2. Closeable
  3. AutoCloseable
  4. Scheduler
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LightArrayRevolverScheduler(config: Config, log: LoggingAdapter, threadFactory: ThreadFactory)

Value Members

  1. val ShutdownTimeout: FiniteDuration
  2. val TickDuration: FiniteDuration
  3. val WheelSize: Int
  4. def close(): Unit
    Definition Classes
    LightArrayRevolverScheduler → Closeable → AutoCloseable
  5. val maxFrequency: Double

    The maximum supported task frequency of this scheduler, i.e.

    The maximum supported task frequency of this scheduler, i.e. the inverse of the minimum time interval between executions of a recurring task, in Hz.

    Definition Classes
    LightArrayRevolverScheduler → Scheduler
  6. def schedule(initialDelay: FiniteDuration, delay: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Definition Classes
    LightArrayRevolverScheduler → Scheduler
  7. final def scheduleAtFixedRate(initialDelay: Duration, interval: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable

    Java API: Schedules a message to be sent repeatedly with an initial delay and frequency.

    Java API: Schedules a message to be sent repeatedly with an initial delay and frequency. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.ZERO and interval=Duration.ofMillis(500)

    It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.

    If the execution is delayed longer than the interval, the subsequent message will be sent immediately after the prior one. This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" messages will be sent when the process wakes up again.

    In the long run, the frequency of messages will be exactly the reciprocal of the specified interval.

    Warning: scheduleAtFixedRate can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

    Note: For scheduling within actors AbstractActorWithTimers should be preferred.

    Definition Classes
    Scheduler
  8. final def scheduleAtFixedRate(initialDelay: FiniteDuration, interval: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef = Actor.noSender): Cancellable

    Scala API: Schedules a message to be sent repeatedly with an initial delay and frequency.

    Scala API: Schedules a message to be sent repeatedly with an initial delay and frequency. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.Zero and interval=Duration(500, TimeUnit.MILLISECONDS)

    It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.

    If the execution is delayed longer than the interval, the subsequent message will be sent immediately after the prior one. This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" messages will be sent when the process wakes up again.

    In the long run, the frequency of messages will be exactly the reciprocal of the specified interval.

    Warning: scheduleAtFixedRate can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

    Note: For scheduling within actors with Timers should be preferred.

    Definition Classes
    Scheduler
    Annotations
    @nowarn()
  9. final def scheduleAtFixedRate(initialDelay: Duration, interval: Duration, runnable: Runnable, executor: ExecutionContext): Cancellable

    Java API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency.

    Java API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay to Duration.ofSeconds(2), and interval to Duration.ofMillis(100).

    It will compensate the delay for a subsequent task if the previous tasks took too long to execute. In such cases, the actual execution interval will differ from the interval passed to the method.

    If the execution of the tasks takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions). This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" tasks will execute when the process wakes up again.

    In the long run, the frequency of execution will be exactly the reciprocal of the specified interval.

    Warning: scheduleAtFixedRate can result in bursts of scheduled tasks after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

    If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

    Definition Classes
    Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

  10. final def scheduleAtFixedRate(initialDelay: FiniteDuration, interval: FiniteDuration)(runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

    Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency.

    Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

    It will compensate the delay for a subsequent task if the previous tasks took too long to execute. In such cases, the actual execution interval will differ from the interval passed to the method.

    If the execution of the tasks takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions). This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" tasks will execute when the process wakes up again.

    In the long run, the frequency of execution will be exactly the reciprocal of the specified interval.

    Warning: scheduleAtFixedRate can result in bursts of scheduled tasks after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

    If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

    Definition Classes
    Scheduler
    Annotations
    @nowarn()
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

  11. def scheduleOnce(delay: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

    Scala API: Schedules a Runnable to be run once with a delay, i.e.

    Scala API: Schedules a Runnable to be run once with a delay, i.e. a time period that has to pass before the runnable is executed.

    Definition Classes
    LightArrayRevolverScheduler → Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

  12. def scheduleOnce(delay: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

    Java API: Schedules a Runnable to be run once with a delay, i.e.

    Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that has to pass before the runnable is executed.

    Definition Classes
    Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

  13. final def scheduleOnce(delay: FiniteDuration)(f: => Unit)(implicit executor: ExecutionContext): Cancellable

    Scala API: Schedules a function to be run once with a delay, i.e.

    Scala API: Schedules a function to be run once with a delay, i.e. a time period that has to pass before the function is run.

    Definition Classes
    Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

  14. final def scheduleOnce(delay: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable

    Java API: Schedules a message to be sent once with a delay, i.e.

    Java API: Schedules a message to be sent once with a delay, i.e. a time period that has to pass before the message is sent.

    Definition Classes
    Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

  15. final def scheduleOnce(delay: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef = Actor.noSender): Cancellable

    Scala API: Schedules a message to be sent once with a delay, i.e.

    Scala API: Schedules a message to be sent once with a delay, i.e. a time period that has to pass before the message is sent.

    Definition Classes
    Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

  16. def scheduleWithFixedDelay(initialDelay: FiniteDuration, delay: FiniteDuration)(runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

    Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions.

    Scala API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

    It will not compensate the delay between tasks if the execution takes a long time or if scheduling is delayed longer than specified for some reason. The delay between subsequent execution will always be (at least) the given delay. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified delay.

    If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

    Definition Classes
    LightArrayRevolverScheduler → Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors with Timers should be preferred.

  17. final def scheduleWithFixedDelay(initialDelay: Duration, delay: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable

    Java API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages.

    Java API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.ZERO and interval=Duration.ofMillis(500).

    It will not compensate the delay between messages if scheduling is delayed longer than specified for some reason. The delay between sending of subsequent messages will always be (at least) the given delay.

    In the long run, the frequency of messages will generally be slightly lower than the reciprocal of the specified delay.

    Note: For scheduling within actors AbstractActorWithTimers should be preferred.

    Definition Classes
    Scheduler
  18. final def scheduleWithFixedDelay(initialDelay: FiniteDuration, delay: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef = Actor.noSender): Cancellable

    Scala API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages.

    Scala API: Schedules a message to be sent repeatedly with an initial delay and a fixed delay between messages. E.g. if you would like a message to be sent immediately and thereafter every 500ms you would set delay=Duration.Zero and interval=Duration(500, TimeUnit.MILLISECONDS).

    It will not compensate the delay between messages if scheduling is delayed longer than specified for some reason. The delay between sending of subsequent messages will always be (at least) the given delay.

    In the long run, the frequency of messages will generally be slightly lower than the reciprocal of the specified delay.

    Note: For scheduling within actors with Timers should be preferred.

    Definition Classes
    Scheduler
    Annotations
    @nowarn()
  19. final def scheduleWithFixedDelay(initialDelay: Duration, delay: Duration, runnable: Runnable, executor: ExecutionContext): Cancellable

    Java API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions.

    Java API: Schedules a Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay to Duration.ofSeconds(2), and interval to Duration.ofMillis(100).

    It will not compensate the delay between tasks if the execution takes a long time or if scheduling is delayed longer than specified for some reason. The delay between subsequent execution will always be (at least) the given delay.

    In the long run, the frequency of tasks will generally be slightly lower than the reciprocal of the specified delay.

    If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

    Definition Classes
    Scheduler
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Note: For scheduling within actors AbstractActorWithTimers should be preferred.

Deprecated Value Members

  1. def schedule(initialDelay: Duration, interval: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  2. final def schedule(initialDelay: FiniteDuration, interval: FiniteDuration)(f: => Unit)(implicit executor: ExecutionContext): Cancellable

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  3. final def schedule(initialDelay: Duration, interval: Duration, receiver: ActorRef, message: Any, executor: ExecutionContext, sender: ActorRef): Cancellable

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Definition Classes
    Scheduler
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.

  4. final def schedule(initialDelay: FiniteDuration, interval: FiniteDuration, receiver: ActorRef, message: Any)(implicit executor: ExecutionContext, sender: ActorRef = Actor.noSender): Cancellable

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Deprecated API: See Scheduler#scheduleWithFixedDelay or Scheduler#scheduleAtFixedRate.

    Definition Classes
    Scheduler
    Annotations
    @deprecated @nowarn()
    Deprecated

    (Since version 2.6.0) Use scheduleWithFixedDelay or scheduleAtFixedRate instead. This has the same semantics as scheduleAtFixedRate, but scheduleWithFixedDelay is often preferred.