Package akka.actor

Class TimerSchedulerImpl

java.lang.Object

akka.actor.TimerScheduler

akka.actor.TimerSchedulerImpl

public class TimerSchedulerImpl
extends TimerScheduler

INTERNAL API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimerSchedulerImpl.InfluenceReceiveTimeoutTimerMsg
static class	TimerSchedulerImpl.InfluenceReceiveTimeoutTimerMsg$
static class	TimerSchedulerImpl.NotInfluenceReceiveTimeoutTimerMsg
static class	TimerSchedulerImpl.NotInfluenceReceiveTimeoutTimerMsg$
static class	TimerSchedulerImpl.Timer
static class	TimerSchedulerImpl.Timer$
static interface	TimerSchedulerImpl.TimerMode
static interface	TimerSchedulerImpl.TimerMsg

Constructor Summary

Constructors

Constructor	Description
TimerSchedulerImpl(ActorContext ctx)

Method Summary

Modifier and Type	Method	Description
void	cancel(java.lang.Object key)	Cancel a timer with a given key.
void	cancelAll()	Cancel all timers.
OptionVal<java.lang.Object>	interceptTimerMsg(TimerSchedulerImpl.TimerMsg timerMsg)
boolean	isTimerActive(java.lang.Object key)	Check if a timer with a given key is active.
void	startPeriodicTimer(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration interval)	Deprecated API: See TimerScheduler.startTimerWithFixedDelay(java.lang.Object, java.lang.Object, scala.concurrent.duration.FiniteDuration) or TimerScheduler.startTimerAtFixedRate(java.lang.Object, java.lang.Object, scala.concurrent.duration.FiniteDuration).
void	startSingleTimer(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout)	Start a timer that will send msg once to the self actor after the given timeout.
void	startTimerAtFixedRate(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration interval)	Scala API: Schedules a message to be sent repeatedly to the self actor with a given frequency.
void	startTimerAtFixedRate(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration initialDelay, scala.concurrent.duration.FiniteDuration interval)	Scala API: Schedules a message to be sent repeatedly to the self actor with a given frequency.
void	startTimerWithFixedDelay(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration delay)	Scala API: Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.
void	startTimerWithFixedDelay(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration initialDelay, scala.concurrent.duration.FiniteDuration delay)	Scala API: Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages after the initialDelay.

Methods inherited from class akka.actor.TimerScheduler

startPeriodicTimer, startSingleTimer, startTimerAtFixedRate, startTimerAtFixedRate, startTimerWithFixedDelay, startTimerWithFixedDelay

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimerSchedulerImpl

public TimerSchedulerImpl(ActorContext ctx)

Method Detail

startTimerAtFixedRate

public void startTimerAtFixedRate(java.lang.Object key,
                                  java.lang.Object msg,
                                  scala.concurrent.duration.FiniteDuration interval)

Description copied from class: TimerScheduler

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. Therefore startTimerWithFixedDelay 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.

Specified by:

startTimerAtFixedRate in class TimerScheduler

startTimerAtFixedRate

public void startTimerAtFixedRate(java.lang.Object key,
                                  java.lang.Object msg,
                                  scala.concurrent.duration.FiniteDuration initialDelay,
                                  scala.concurrent.duration.FiniteDuration interval)

Description copied from class: TimerScheduler

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 after initialDelay.

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. Therefore startTimerWithFixedDelay 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.

Specified by:

startTimerAtFixedRate in class TimerScheduler

startTimerWithFixedDelay

public void startTimerWithFixedDelay(java.lang.Object key,
                                     java.lang.Object msg,
                                     scala.concurrent.duration.FiniteDuration delay)

Description copied from class: TimerScheduler

Scala API: Schedules a message to be sent repeatedly to the self actor with a fixed delay 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.

Specified by:

startTimerWithFixedDelay in class TimerScheduler

startTimerWithFixedDelay

public void startTimerWithFixedDelay(java.lang.Object key,
                                     java.lang.Object msg,
                                     scala.concurrent.duration.FiniteDuration initialDelay,
                                     scala.concurrent.duration.FiniteDuration delay)

Description copied from class: TimerScheduler

Scala API: Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages after the initialDelay.

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.

Specified by:

startTimerWithFixedDelay in class TimerScheduler

startPeriodicTimer

public void startPeriodicTimer(java.lang.Object key,
                               java.lang.Object msg,
                               scala.concurrent.duration.FiniteDuration interval)

Description copied from class: TimerScheduler

Deprecated API: See TimerScheduler.startTimerWithFixedDelay(java.lang.Object, java.lang.Object, scala.concurrent.duration.FiniteDuration) or TimerScheduler.startTimerAtFixedRate(java.lang.Object, java.lang.Object, scala.concurrent.duration.FiniteDuration).

Specified by:

startPeriodicTimer in class TimerScheduler

startSingleTimer

public void startSingleTimer(java.lang.Object key,
                             java.lang.Object msg,
                             scala.concurrent.duration.FiniteDuration timeout)

Description copied from class: TimerScheduler

Start a timer that will send msg once to the self actor after the given timeout.

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.

Specified by:

startSingleTimer in class TimerScheduler

isTimerActive

public boolean isTimerActive(java.lang.Object key)

Description copied from class: TimerScheduler

Check if a timer with a given key is active.

Specified by:

isTimerActive in class TimerScheduler

cancel

public void cancel(java.lang.Object key)

Description copied from class: TimerScheduler

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.

Specified by:

cancel in class TimerScheduler

cancelAll

public void cancelAll()

Description copied from class: TimerScheduler

Cancel all timers.

Specified by:

cancelAll in class TimerScheduler

interceptTimerMsg

public OptionVal<java.lang.Object> interceptTimerMsg(TimerSchedulerImpl.TimerMsg timerMsg)