Packages

t

akka.actor.typed.javadsl

TimerScheduler

trait TimerScheduler[T] extends AnyRef

Support for scheduled self messages in an actor. It is used with Behaviors.withTimers, which also takes care of the lifecycle of the timers such as cancelling them when the actor 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: Duration): 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: Duration): 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.