Packages

c

akka.actor

TimerScheduler

abstract class TimerScheduler extends AnyRef

Support for scheduled self messages in an actor. It is used by mixing in trait Timers in Scala or extending AbstractActorWithTimers in Java.

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.

Annotations
@DoNotInherit()
Source
Timers.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimerScheduler
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TimerScheduler()

Abstract Value Members

  1. 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.

  2. abstract def cancelAll(): Unit

    Cancel all timers.

  3. abstract def isTimerActive(key: Any): Boolean

    Check if a timer with a given key is active.

  4. abstract def startSingleTimer(key: Any, msg: Any, timeout: FiniteDuration): Unit

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

    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.

  5. abstract def startTimerAtFixedRate(key: Any, msg: Any, initialDelay: FiniteDuration, interval: FiniteDuration): Unit

    Scala API: Schedules a message to be sent repeatedly to the self actor with a given frequency.

    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.

  6. abstract def startTimerAtFixedRate(key: Any, msg: Any, interval: FiniteDuration): Unit

    Scala API: Schedules a message to be sent repeatedly to the self actor with a given frequency.

    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.

  7. abstract def startTimerWithFixedDelay(key: Any, msg: Any, initialDelay: FiniteDuration, delay: FiniteDuration): Unit

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

    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.

  8. abstract def startTimerWithFixedDelay(key: Any, msg: Any, delay: FiniteDuration): Unit

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

    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.

  9. abstract def startPeriodicTimer(key: Any, msg: Any, interval: FiniteDuration): Unit

    Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.

    Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use startTimerWithFixedDelay or startTimerAtFixedRate instead. This has the same semantics as startTimerAtFixedRate, but startTimerWithFixedDelay is often preferred.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TimerScheduler toany2stringadd[TimerScheduler] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TimerScheduler, B)
    Implicit
    This member is added by an implicit conversion from TimerScheduler toArrowAssoc[TimerScheduler] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (TimerScheduler) => Boolean, msg: => Any): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TimerScheduler) => Boolean): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TimerScheduler
    Implicit
    This member is added by an implicit conversion from TimerScheduler toEnsuring[TimerScheduler] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def startSingleTimer(key: Any, msg: Any, timeout: Duration): Unit

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

    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.

  21. final def startTimerAtFixedRate(key: Any, msg: Any, initialDelay: Duration, interval: Duration): Unit

    Java API: Schedules a message to be sent repeatedly to the self actor with a given frequency.

    Java 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.

  22. final def startTimerAtFixedRate(key: Any, msg: Any, interval: Duration): Unit

    Java API: Schedules a message to be sent repeatedly to the self actor with a given frequency.

    Java 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.

  23. final def startTimerWithFixedDelay(key: Any, msg: Any, initialDelay: Duration, delay: Duration): Unit

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

    Java 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.

  24. final def startTimerWithFixedDelay(key: Any, msg: Any, delay: Duration): Unit

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

    Java 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.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TimerScheduler toStringFormat[TimerScheduler] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. final def startPeriodicTimer(key: Any, msg: Any, interval: Duration): Unit

    Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.

    Deprecated API: See TimerScheduler#startTimerWithFixedDelay or TimerScheduler#startTimerAtFixedRate.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use startTimerWithFixedDelay or startTimerAtFixedRate instead. This has the same semantics as startTimerAtFixedRate, but startTimerWithFixedDelay is often preferred.

  4. def →[B](y: B): (TimerScheduler, B)
    Implicit
    This member is added by an implicit conversion from TimerScheduler toArrowAssoc[TimerScheduler] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTimerScheduler to any2stringadd[TimerScheduler]

Inherited by implicit conversion StringFormat fromTimerScheduler to StringFormat[TimerScheduler]

Inherited by implicit conversion Ensuring fromTimerScheduler to Ensuring[TimerScheduler]

Inherited by implicit conversion ArrowAssoc fromTimerScheduler to ArrowAssoc[TimerScheduler]

Ungrouped