Package akka.actor.typed.internal

Class TimerSchedulerImpl<T>

java.lang.Object

akka.actor.typed.internal.TimerSchedulerImpl<T>

All Implemented Interfaces:

TimerScheduler<T>, TimerScheduler<T>

public class TimerSchedulerImpl<T>
extends java.lang.Object
implements TimerScheduler<T>, TimerScheduler<T>

INTERNAL API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimerSchedulerImpl.Timer<T>
static class	TimerSchedulerImpl.Timer$
static interface	TimerSchedulerImpl.TimerMode
static class	TimerSchedulerImpl.TimerMsg

Constructor Summary

Constructors

Constructor	Description
TimerSchedulerImpl(ActorContext<T> 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<T>	interceptTimerMsg(org.slf4j.Logger log, 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, T msg, java.time.Duration interval)	Deprecated API: See TimerScheduler.startTimerWithFixedDelay(java.lang.Object, T, java.time.Duration) or TimerScheduler.startTimerAtFixedRate(java.lang.Object, T, java.time.Duration).
void	startPeriodicTimer(java.lang.Object key, T msg, scala.concurrent.duration.FiniteDuration interval)	Deprecated API: See TimerScheduler.startTimerWithFixedDelay(java.lang.Object, T, scala.concurrent.duration.FiniteDuration) or TimerScheduler.startTimerAtFixedRate(java.lang.Object, T, scala.concurrent.duration.FiniteDuration).
void	startSingleTimer(java.lang.Object key, T msg, java.time.Duration delay)	Start a timer that will send msg once to the self actor after the given delay.
void	startSingleTimer(java.lang.Object key, T msg, scala.concurrent.duration.FiniteDuration delay)	Start a timer that will send msg once to the self actor after the given delay.
void	startTimerAtFixedRate(java.lang.Object key, T msg, java.time.Duration interval)	Schedules a message to be sent repeatedly to the self actor with a given frequency.
void	startTimerAtFixedRate(java.lang.Object key, T msg, scala.concurrent.duration.FiniteDuration interval)	Schedules a message to be sent repeatedly to the self actor with a given frequency.
void	startTimerWithFixedDelay(java.lang.Object key, T msg, java.time.Duration delay)	Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.
void	startTimerWithFixedDelay(java.lang.Object key, T msg, scala.concurrent.duration.FiniteDuration delay)	Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.
static <T> Behavior<T>	withTimers(scala.Function1<TimerSchedulerImpl<T>,Behavior<T>> factory)
static <T> Behavior<T>	wrapWithTimers(scala.Function1<TimerSchedulerImpl<T>,Behavior<T>> factory, ActorContext<T> ctx)

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.typed.javadsl.TimerScheduler

startSingleTimer, startTimerAtFixedRate, startTimerWithFixedDelay

Methods inherited from interface akka.actor.typed.scaladsl.TimerScheduler

startSingleTimer, startTimerAtFixedRate, startTimerWithFixedDelay

Constructor Detail

TimerSchedulerImpl

public TimerSchedulerImpl(ActorContext<T> ctx)

Method Detail

withTimers

public static <T> Behavior<T> withTimers(scala.Function1<TimerSchedulerImpl<T>,Behavior<T>> factory)

wrapWithTimers

public static <T> Behavior<T> wrapWithTimers(scala.Function1<TimerSchedulerImpl<T>,Behavior<T>> factory,
                                             ActorContext<T> ctx)

startTimerAtFixedRate

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

Description copied from interface: TimerScheduler

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 interface TimerScheduler<T>

startTimerAtFixedRate

public void startTimerAtFixedRate(java.lang.Object key,
                                  T msg,
                                  java.time.Duration interval)

Description copied from interface: TimerScheduler

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 interface TimerScheduler<T>

startTimerWithFixedDelay

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

Description copied from interface: TimerScheduler

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 be enqueued in the mailbox before the new timer was started.

Specified by:

startTimerWithFixedDelay in interface TimerScheduler<T>

startTimerWithFixedDelay

public void startTimerWithFixedDelay(java.lang.Object key,
                                     T msg,
                                     java.time.Duration delay)

Description copied from interface: TimerScheduler

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 interface TimerScheduler<T>

startPeriodicTimer

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

Description copied from interface: TimerScheduler

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

Specified by:

startPeriodicTimer in interface TimerScheduler<T>

startPeriodicTimer

public void startPeriodicTimer(java.lang.Object key,
                               T msg,
                               java.time.Duration interval)

Description copied from interface: TimerScheduler

Deprecated API: See TimerScheduler.startTimerWithFixedDelay(java.lang.Object, T, java.time.Duration) or TimerScheduler.startTimerAtFixedRate(java.lang.Object, T, java.time.Duration).

Specified by:

startPeriodicTimer in interface TimerScheduler<T>

startSingleTimer

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

Description copied from interface: TimerScheduler

Start a timer that will send msg once to the self actor after the given 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:

startSingleTimer in interface TimerScheduler<T>

startSingleTimer

public void startSingleTimer(java.lang.Object key,
                             T msg,
                             java.time.Duration delay)

Description copied from interface: TimerScheduler

Start a timer that will send msg once to the self actor after the given 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:

startSingleTimer in interface TimerScheduler<T>

isTimerActive

public boolean isTimerActive(java.lang.Object key)

Description copied from interface: TimerScheduler

Check if a timer with a given key is active.

Specified by:

isTimerActive in interface TimerScheduler<T>

Specified by:

isTimerActive in interface TimerScheduler<T>

cancel

public void cancel(java.lang.Object key)

Description copied from interface: 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 interface TimerScheduler<T>

Specified by:

cancel in interface TimerScheduler<T>

cancelAll

public void cancelAll()

Description copied from interface: TimerScheduler

Cancel all timers.

Specified by:

cancelAll in interface TimerScheduler<T>

Specified by:

cancelAll in interface TimerScheduler<T>

interceptTimerMsg

public OptionVal<T> interceptTimerMsg(org.slf4j.Logger log,
                                      TimerSchedulerImpl.TimerMsg timerMsg)