trait TimerScheduler[T] extends AnyRef
Support for scheduled self
messages in an actor.
It is used with Behaviors.withTimers
.
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.
Not for user extension.
- Annotations
- @DoNotInherit()
- Source
- TimerScheduler.scala
- Alphabetic
- By Inheritance
- TimerScheduler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 startSingleTimer(key: Any, msg: T, delay: FiniteDuration): Unit
Start a timer that will send
msg
once to theself
actor after the givendelay
.Start a timer that will send
msg
once to theself
actor after the givendelay
.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.
- abstract def startTimerAtFixedRate(key: Any, msg: T, initialDelay: FiniteDuration, interval: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a given frequency.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
afterinitialDelay
.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. ThereforestartTimerWithFixedDelay
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.
- abstract def startTimerAtFixedRate(key: Any, msg: T, interval: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a given frequency.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. ThereforestartTimerWithFixedDelay
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.
- abstract def startTimerWithFixedDelay(key: Any, msg: T, initialDelay: FiniteDuration, delay: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages after theinitialDelay
.Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages after theinitialDelay
.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.
- abstract def startTimerWithFixedDelay(key: Any, msg: T, delay: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages.Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
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.
- abstract def startPeriodicTimer(key: Any, msg: T, interval: FiniteDuration): Unit
Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.
Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use startTimerWithFixedDelay or startTimerAtFixedRate instead. This has the same semantics as startTimerAtFixedRate, but startTimerWithFixedDelay is often preferred.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toany2stringadd[TimerScheduler[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (TimerScheduler[T], B)
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toArrowAssoc[TimerScheduler[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (TimerScheduler[T]) => Boolean, msg: => Any): TimerScheduler[T]
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toEnsuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (TimerScheduler[T]) => Boolean): TimerScheduler[T]
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toEnsuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): TimerScheduler[T]
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toEnsuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): TimerScheduler[T]
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toEnsuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def startSingleTimer(msg: T, delay: FiniteDuration): Unit
Start a timer that will send
msg
once to theself
actor after the givendelay
.Start a timer that will send
msg
once to theself
actor after the givendelay
.If a new timer is started with the same message 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. If you do not want this, you can start start them as individual timers by specifying distinct keys.
- def startTimerAtFixedRate(msg: T, initialDelay: FiniteDuration, interval: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a given frequency.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
afterinitialDelay
.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. ThereforestartTimerWithFixedDelay
is often preferred.When a new timer is started with the same message 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. If you do not want this, you can start start them as individual timers by specifying distinct keys.
- def startTimerAtFixedRate(msg: T, interval: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a given frequency.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. ThereforestartTimerWithFixedDelay
is often preferred.When a new timer is started with the same message 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. If you do not want this, you can start start them as individual timers by specifying distinct keys.
- def startTimerWithFixedDelay(msg: T, initialDelay: FiniteDuration, delay: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages after theinitialDelay
.Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages after theinitialDelay
.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
.When a new timer is started with the same message, 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. If you do not want this, you can start start them as individual timers by specifying distinct keys.
- def startTimerWithFixedDelay(msg: T, delay: FiniteDuration): Unit
Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
between messages.Schedules a message to be sent repeatedly to the
self
actor with a fixeddelay
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
.When a new timer is started with the same message, 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. If you do not want this, you can start start them as individual timers by specifying distinct keys.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toStringFormat[TimerScheduler[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (TimerScheduler[T], B)
- Implicit
- This member is added by an implicit conversion from TimerScheduler[T] toArrowAssoc[TimerScheduler[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.