trait Scheduler extends AnyRef
The ActorSystem facility for scheduling tasks.
For scheduling within actors Behaviors.withTimers
should be preferred.
Not for user extension
- Annotations
- @DoNotInherit()
- Source
- Scheduler.scala
- Alphabetic
- By Inheritance
- Scheduler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract 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.- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling in actorsBehaviors.withTimers
should be preferred.
- abstract 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.- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling within actorsBehaviors.withTimers
should be preferred.
- abstract def scheduleOnce(delay: Duration, runnable: Runnable, 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.
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling within actorsBehaviors.withTimers
orActorContext.scheduleOnce
should be preferred.
- 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.
- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling within actorsBehaviors.withTimers
orActorContext.scheduleOnce
should be preferred.
- abstract 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.- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling in actorsBehaviors.withTimers
should be preferred.
- abstract 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.- Exceptions thrown
IllegalArgumentException
if the given delays exceed the maximum reach (calculated as:delay / tickNanos > Int.MaxValue
). Note: For scheduling within actorsBehaviors.withTimers
should be preferred.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Scheduler, B)
- 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(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (Scheduler) => Boolean, msg: => Any): Scheduler
- def ensuring(cond: (Scheduler) => Boolean): Scheduler
- def ensuring(cond: Boolean, msg: => Any): Scheduler
- def ensuring(cond: Boolean): Scheduler
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Scheduler toStringFormat[Scheduler] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Scheduler, B)
- Implicit
- This member is added by an implicit conversion from Scheduler toArrowAssoc[Scheduler] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.