Package org.apache.pekko.actor.typed.internal

Interface TimerSchedulerCrossDslSupport<T>

All Superinterfaces:

TimerScheduler<T>, TimerScheduler<T>

public interface TimerSchedulerCrossDslSupport<T>
extends TimerScheduler<T>, TimerScheduler<T>

Method Summary

Modifier and Type	Method	Description
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	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	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, java.time.Duration initialDelay, java.time.Duration 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, java.time.Duration initialDelay, java.time.Duration delay)	Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages after initialDelay.

Methods inherited from interface org.apache.pekko.actor.typed.javadsl.TimerScheduler

cancel, cancelAll, isTimerActive, startSingleTimer, startTimerAtFixedRate, startTimerAtFixedRate, startTimerWithFixedDelay, startTimerWithFixedDelay

Methods inherited from interface org.apache.pekko.actor.typed.scaladsl.TimerScheduler

cancel, cancelAll, isTimerActive, startPeriodicTimer, startSingleTimer, startSingleTimer, startTimerAtFixedRate, startTimerAtFixedRate, startTimerAtFixedRate, startTimerAtFixedRate, startTimerWithFixedDelay, startTimerWithFixedDelay, startTimerWithFixedDelay, startTimerWithFixedDelay

Method Detail

startPeriodicTimer

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

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>

startTimerAtFixedRate

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>

startTimerAtFixedRate

void startTimerAtFixedRate(java.lang.Object key,
                           T msg,
                           java.time.Duration initialDelay,
                           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 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 interface TimerScheduler<T>

startTimerWithFixedDelay

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>

startTimerWithFixedDelay

void startTimerWithFixedDelay(java.lang.Object key,
                              T msg,
                              java.time.Duration initialDelay,
                              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 after 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 interface TimerScheduler<T>