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
startPeriodicTimer(key: Any, msg: Any, interval: FiniteDuration): Unit
Start a periodic timer that will send
msg
to theself
actor at a fixedinterval
.Start a periodic timer that will send
msg
to theself
actor at a fixedinterval
.Each timer has a key and if a new timer with same key is started the previous is cancelled and it's guaranteed that a message from the previous timer is not received, even though it might already be enqueued in the mailbox when the new timer is started.
-
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 and it's guaranteed that a message from the previous timer is not received, even though it might already be enqueued in the mailbox when the new timer is started.
Concrete Value Members
-
def
startPeriodicTimer(key: Any, msg: Any, interval: Duration): Unit
Start a periodic timer that will send
msg
to theself
actor at a fixedinterval
.Start a periodic timer that will send
msg
to theself
actor at a fixedinterval
.Each timer has a key and if a new timer with same key is started the previous is cancelled and it's guaranteed that a message from the previous timer is not received, even though it might already be enqueued in the mailbox when the new timer is started.
-
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 and it's guaranteed that a message from the previous timer is not received, even though it might already be enqueued in the mailbox when the new timer is started.