abstract class TimerScheduler extends AnyRef
Support for scheduled self
messages in an actor.
It is used by mixing in trait Timers
in Scala or extending AbstractActorWithTimers
in Java.
Timers are bound to the lifecycle of the actor that owns it, and thus are cancelled automatically when it is restarted or stopped.
TimerScheduler
is not thread-safe, i.e. it must only be used within
the actor that owns it.
- Annotations
- @DoNotInherit()
- Source
- Timers.scala
- Alphabetic
- By Inheritance
- TimerScheduler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new TimerScheduler()
Abstract Value Members
-
abstract
def
cancel(key: Any): Unit
Cancel a timer with a given
key
.Cancel a timer with a given
key
. If canceling a timer that was already canceled, or key never was used to start a timer this operation will do nothing.It is guaranteed that a message from a canceled timer, including its previous incarnation for the same key, will not be received by the actor, even though the message might already be enqueued in the mailbox when cancel is called.
-
abstract
def
cancelAll(): Unit
Cancel all timers.
-
abstract
def
isTimerActive(key: Any): Boolean
Check if a timer with a given
key
is active. -
abstract
def
startSingleTimer(key: Any, msg: Any, timeout: FiniteDuration): Unit
Start a timer that will send
msg
once to theself
actor after the giventimeout
.Start a timer that will send
msg
once to theself
actor after the giventimeout
.Each timer has a key and if a new timer with same key is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.
-
abstract
def
startTimerAtFixedRate(key: Any, msg: Any, interval: FiniteDuration): Unit
Scala API: Schedules a message to be sent repeatedly to the
self
actor with a given frequency.Scala API: Schedules a message to be sent repeatedly to the
self
actor with a given frequency.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:
startTimerAtFixedRate
can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. ThereforestartTimerWithFixedDelay
is often preferred.Each timer has a key and if a new timer with same key is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.
-
abstract
def
startTimerWithFixedDelay(key: Any, msg: Any, delay: FiniteDuration): Unit
Scala API: Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages.Scala API: Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages.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
.Each timer has a key and if a new timer with same key is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.
-
abstract
def
startPeriodicTimer(key: Any, msg: Any, interval: FiniteDuration): Unit
Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.
Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.
- 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 TimerScheduler to any2stringadd[TimerScheduler] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (TimerScheduler, B)
- Implicit
- This member is added by an implicit conversion from TimerScheduler to ArrowAssoc[TimerScheduler] 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: (TimerScheduler) ⇒ Boolean, msg: ⇒ Any): TimerScheduler
- Implicit
- This member is added by an implicit conversion from TimerScheduler to Ensuring[TimerScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (TimerScheduler) ⇒ Boolean): TimerScheduler
- Implicit
- This member is added by an implicit conversion from TimerScheduler to Ensuring[TimerScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): TimerScheduler
- Implicit
- This member is added by an implicit conversion from TimerScheduler to Ensuring[TimerScheduler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): TimerScheduler
- Implicit
- This member is added by an implicit conversion from TimerScheduler to Ensuring[TimerScheduler] 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 TimerScheduler to StringFormat[TimerScheduler] 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()
-
final
def
startSingleTimer(key: Any, msg: Any, timeout: Duration): Unit
Start a timer that will send
msg
once to theself
actor after the giventimeout
.Start a timer that will send
msg
once to theself
actor after the giventimeout
.Each timer has a key and if a new timer with same key is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.
-
final
def
startTimerAtFixedRate(key: Any, msg: Any, interval: Duration): Unit
Java API: Schedules a message to be sent repeatedly to the
self
actor with a given frequency.Java API: Schedules a message to be sent repeatedly to the
self
actor with a given frequency.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:
startTimerAtFixedRate
can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. ThereforestartTimerWithFixedDelay
is often preferred.Each timer has a key and if a new timer with same key is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.
-
final
def
startTimerWithFixedDelay(key: Any, msg: Any, delay: Duration): Unit
Java API: Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages.Java API: Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages.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
.Each timer has a key and if a new timer with same key is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.
-
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): (TimerScheduler, B)
- Implicit
- This member is added by an implicit conversion from TimerScheduler to ArrowAssoc[TimerScheduler] 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.
-
final
def
startPeriodicTimer(key: Any, msg: Any, interval: Duration): Unit
Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.
Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0)