Packages

t

akka.actor.typed.scaladsl

TimerScheduler

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.

Source
TimerScheduler.scala
Linear Supertypes
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. All

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 startPeriodicTimer(key: Any, msg: T, interval: FiniteDuration): Unit

    Start a periodic timer that will send msg to the self actor at a fixed interval.

    Start a periodic timer that will send msg to the self actor at a fixed interval.

    Each timer has a key and if a new timer with same key is started the previous is cancelled and it's guaranteed that a message from the previous timer is not received, even though it might already be enqueued in the mailbox when the new timer is started.

  5. abstract def startSingleTimer(key: Any, msg: T, delay: FiniteDuration): Unit

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

    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 and it's guaranteed that a message from the previous timer is not received, even though it might already be enqueued in the mailbox when the new timer is started.

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[T] to any2stringadd[TimerScheduler[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TimerScheduler[T], B)
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to ArrowAssoc[TimerScheduler[T]] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (TimerScheduler[T]) ⇒ Boolean, msg: ⇒ Any): TimerScheduler[T]
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to Ensuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TimerScheduler[T]) ⇒ Boolean): TimerScheduler[T]
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to Ensuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): TimerScheduler[T]
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to Ensuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TimerScheduler[T]
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to Ensuring[TimerScheduler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to StringFormat[TimerScheduler[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (TimerScheduler[T], B)
    Implicit
    This member is added by an implicit conversion from TimerScheduler[T] to ArrowAssoc[TimerScheduler[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TimerScheduler[T] to any2stringadd[TimerScheduler[T]]

Inherited by implicit conversion StringFormat from TimerScheduler[T] to StringFormat[TimerScheduler[T]]

Inherited by implicit conversion Ensuring from TimerScheduler[T] to Ensuring[TimerScheduler[T]]

Inherited by implicit conversion ArrowAssoc from TimerScheduler[T] to ArrowAssoc[TimerScheduler[T]]

Ungrouped