Class TimerScheduler
- java.lang.Object
-
- akka.actor.TimerScheduler
-
- Direct Known Subclasses:
TimerSchedulerImpl
public abstract class TimerScheduler extends java.lang.Object
Start a periodic timer that will sendmsg
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.
-
-
Constructor Summary
Constructors Constructor Description TimerScheduler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
cancel(java.lang.Object key)
Cancel a timer with a givenkey
.abstract void
cancelAll()
Cancel all timers.abstract boolean
isTimerActive(java.lang.Object key)
Check if a timer with a givenkey
is active.void
startPeriodicTimer(java.lang.Object key, java.lang.Object msg, java.time.Duration interval)
Start a periodic timer that will sendmsg
to theself
actor at a fixedinterval
.abstract void
startPeriodicTimer(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration interval)
void
startSingleTimer(java.lang.Object key, java.lang.Object msg, java.time.Duration timeout)
Start a timer that will sendmsg
once to theself
actor after the giventimeout
.abstract void
startSingleTimer(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout)
Start a timer that will sendmsg
once to theself
actor after the giventimeout
.
-
-
-
Method Detail
-
cancel
public abstract void cancel(java.lang.Object key)
Cancel a timer with a givenkey
. 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.
- Parameters:
key
- (undocumented)
-
cancelAll
public abstract void cancelAll()
Cancel all timers.
-
isTimerActive
public abstract boolean isTimerActive(java.lang.Object key)
Check if a timer with a givenkey
is active.- Parameters:
key
- (undocumented)- Returns:
- (undocumented)
-
startPeriodicTimer
public abstract void startPeriodicTimer(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration interval)
-
startPeriodicTimer
public void startPeriodicTimer(java.lang.Object key, java.lang.Object msg, java.time.Duration interval)
Start a periodic timer that will sendmsg
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.
- Parameters:
key
- (undocumented)msg
- (undocumented)interval
- (undocumented)
-
startSingleTimer
public abstract void startSingleTimer(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout)
Start a timer that will sendmsg
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.
- Parameters:
key
- (undocumented)msg
- (undocumented)timeout
- (undocumented)
-
startSingleTimer
public void startSingleTimer(java.lang.Object key, java.lang.Object msg, java.time.Duration timeout)
Start a timer that will sendmsg
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.
- Parameters:
key
- (undocumented)msg
- (undocumented)timeout
- (undocumented)
-
-