Packages

t

akka.actor

Scheduler

trait Scheduler extends AnyRef

An Akka scheduler service. This one needs one special behavior: if Closeable, it MUST execute all outstanding tasks upon .close() in order to properly shutdown all dispatchers.

Furthermore, this timer service MUST throw IllegalStateException if it cannot schedule a task. Once scheduled, the task MUST be executed. If executed upon close(), the task may execute before its timeout.

Scheduler implementation are loaded reflectively at ActorSystem start-up with the following constructor arguments: 1) the system’s com.typesafe.config.Config (from system.settings.config) 2) a akka.event.LoggingAdapter 3) a java.util.concurrent.ThreadFactory

Please note that this scheduler implementation is higly optimised for high-throughput and high-frequency events. It is not to be confused with long-term schedulers such as Quartz. The scheduler will throw an exception if attempts are made to schedule too far into the future (which by default is around 8 months (Int.MaxValue seconds).

Source
Scheduler.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractScheduler, AbstractSchedulerBase, LightArrayRevolverScheduler, ExplicitlyTriggeredScheduler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scheduler
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def 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.

  2. abstract def schedule(initialDelay: FiniteDuration, interval: FiniteDuration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

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

    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). If the execution of the runnable takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions of the runnable). In such cases, the actual execution interval will differ from the interval passed to this method.

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Java API

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

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

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Java & Scala API

Concrete Value Members

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

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

    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). If the execution of the runnable takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions of the runnable). In such cases, the actual execution interval will differ from the interval passed to this method.

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Java API

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

    Schedules a function to be run repeatedly with an initial delay and a frequency.

    Schedules a function 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). If the execution of the function takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of the function executions). In such cases, the actual execution interval will differ from the interval passed to this method.

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

    Scala API

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

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

    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)

    Java API

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

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

    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)

    Java & Scala API

    Annotations
    @silent()
  5. def scheduleOnce(delay: Duration, runnable: Runnable)(implicit executor: ExecutionContext): Cancellable

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

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Java & Scala API

  6. final def scheduleOnce(delay: FiniteDuration)(f: ⇒ Unit)(implicit executor: ExecutionContext): Cancellable

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

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Scala API

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

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

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Java API

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

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

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

    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum reach (calculated as: delay / tickNanos > Int.MaxValue). Java & Scala API