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
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
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
- Scheduler
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling within actorswith Timers
should be preferred.
-
abstract
def
schedule(initialDelay: FiniteDuration, interval: 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
- Scheduler
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0)
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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)
-
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
andinterval=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. ThereforescheduleWithFixedDelay
is often preferred.Note: For scheduling within actors
AbstractActorWithTimers
should be preferred.- Definition Classes
- Scheduler
-
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
andinterval=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. ThereforescheduleWithFixedDelay
is often preferred.Note: For scheduling within actors
with Timers
should be preferred.- Definition Classes
- Scheduler
- Annotations
- @silent( "deprecated" )
-
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 toDuration.ofSeconds(2)
, and interval toDuration.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. ThereforescheduleWithFixedDelay
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 actorsAbstractActorWithTimers
should be preferred.
-
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 setdelay=Duration(2, TimeUnit.SECONDS)
andinterval=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. ThereforescheduleWithFixedDelay
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
- @silent( "deprecated" )
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling within actorswith Timers
should be preferred.
-
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
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 actorsAbstractActorWithTimers
should be preferred.
-
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 actorswith Timers
should be preferred.
-
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 actorsAbstractActorWithTimers
should be preferred.
-
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 actorswith Timers
should be preferred.
-
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 setdelay=Duration.ZERO
andinterval=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
-
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 setdelay=Duration.Zero
andinterval=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
- @silent( "deprecated" )
-
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 fixeddelay
between subsequent executions.Java API: Schedules a
Runnable
to be run repeatedly with an initial delay and a fixeddelay
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 toDuration.ofSeconds(2)
, and interval toDuration.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 actorsAbstractActorWithTimers
should be preferred.
-
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 fixeddelay
between subsequent executions.Scala API: Schedules a
Runnable
to be run repeatedly with an initial delay and a fixeddelay
between subsequent executions. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would setdelay=Duration(2, TimeUnit.SECONDS)
andinterval=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 specifieddelay
.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 actorswith Timers
should be preferred.
-
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
- @throws( ... ) @native()
-
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
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
-
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)
-
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)
-
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)
-
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 @silent( "deprecated" )
- Deprecated
(Since version 2.6.0)