abstract class AbstractScheduler extends AbstractSchedulerBase
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
- Source
- AbstractScheduler.java
- Alphabetic
- By Inheritance
- AbstractScheduler
- AbstractSchedulerBase
- Scheduler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new AbstractScheduler()
Abstract Value Members
-
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.
- Definition Classes
- AbstractScheduler → Scheduler
-
abstract
def
schedule(initialDelay: FiniteDuration, interval: FiniteDuration, runnable: Runnable, 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)
-
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.- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Java API
-
abstract
def
scheduleOnce(delay: FiniteDuration, runnable: Runnable, 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.
-
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.
- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Java & Scala API
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to any2stringadd[AbstractScheduler] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (AbstractScheduler, B)
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to ArrowAssoc[AbstractScheduler] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (AbstractScheduler) ⇒ Boolean, msg: ⇒ Any): AbstractScheduler
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to Ensuring[AbstractScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (AbstractScheduler) ⇒ Boolean): AbstractScheduler
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to Ensuring[AbstractScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): AbstractScheduler
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to Ensuring[AbstractScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): AbstractScheduler
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to Ensuring[AbstractScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to StringFormat[AbstractScheduler] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
schedule(initialDelay: Duration, interval: Duration, runnable: Runnable, 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.ofMillis(100)
-
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.- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Java API
-
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
- Definition Classes
- Scheduler
-
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
- Definition Classes
- Scheduler
-
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
- Definition Classes
- Scheduler
- Annotations
- @silent()
-
def
scheduleOnce(delay: Duration, runnable: Runnable, 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.
-
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.
- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Java & Scala API
-
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.
- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Scala API
-
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.
- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Java API
-
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.
- Definition Classes
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Java & Scala API
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (AbstractScheduler, B)
- Implicit
- This member is added by an implicit conversion from AbstractScheduler to ArrowAssoc[AbstractScheduler] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc