Package akka.actor

Class TimerScheduler

  • Direct Known Subclasses:
    TimerSchedulerImpl

    public abstract class TimerScheduler
    extends java.lang.Object
    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 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.

    • Constructor Summary

      Constructors 
      Constructor Description
      TimerScheduler()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      abstract void cancel​(java.lang.Object key)
      Cancel a timer with a given key.
      abstract void cancelAll()
      Cancel all timers.
      abstract boolean isTimerActive​(java.lang.Object key)
      Check if a timer with a given key is active.
      void startPeriodicTimer​(java.lang.Object key, java.lang.Object msg, java.time.Duration interval)
      Deprecated.
      Use startTimerWithFixedDelay or startTimerAtFixedRate instead.
      abstract void startPeriodicTimer​(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration interval)
      Deprecated.
      Use startTimerWithFixedDelay or startTimerAtFixedRate instead.
      void startSingleTimer​(java.lang.Object key, java.lang.Object msg, java.time.Duration timeout)
      Start a timer that will send msg once to the self actor after the given timeout.
      abstract void startSingleTimer​(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout)
      Start a timer that will send msg once to the self actor after the given timeout.
      void startTimerAtFixedRate​(java.lang.Object key, java.lang.Object msg, java.time.Duration interval)
      Java API: Schedules a message to be sent repeatedly to the self actor with a given frequency.
      abstract void startTimerAtFixedRate​(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration interval)
      Scala API: Schedules a message to be sent repeatedly to the self actor with a given frequency.
      void startTimerWithFixedDelay​(java.lang.Object key, java.lang.Object msg, java.time.Duration delay)
      Java API: Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.
      abstract void startTimerWithFixedDelay​(java.lang.Object key, java.lang.Object msg, scala.concurrent.duration.FiniteDuration delay)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TimerScheduler

        public TimerScheduler()
    • Method Detail

      • cancel

        public abstract void cancel​(java.lang.Object 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.

        Parameters:
        key - (undocumented)
      • cancelAll

        public abstract void cancelAll()
        Cancel all timers.
      • isTimerActive

        public abstract boolean isTimerActive​(java.lang.Object key)
        Check if a timer with a given key is active.
        Parameters:
        key - (undocumented)
        Returns:
        (undocumented)
      • startSingleTimer

        public abstract void startSingleTimer​(java.lang.Object key,
                                              java.lang.Object msg,
                                              scala.concurrent.duration.FiniteDuration 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 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.

        Parameters:
        key - (undocumented)
        msg - (undocumented)
        timeout - (undocumented)
      • startSingleTimer

        public final void startSingleTimer​(java.lang.Object key,
                                           java.lang.Object msg,
                                           java.time.Duration 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 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.

        Parameters:
        key - (undocumented)
        msg - (undocumented)
        timeout - (undocumented)
      • startTimerAtFixedRate

        public abstract void startTimerAtFixedRate​(java.lang.Object key,
                                                   java.lang.Object msg,
                                                   scala.concurrent.duration.FiniteDuration interval)
        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 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.

        Parameters:
        key - (undocumented)
        msg - (undocumented)
        interval - (undocumented)
      • startTimerAtFixedRate

        public final void startTimerAtFixedRate​(java.lang.Object key,
                                                java.lang.Object msg,
                                                java.time.Duration interval)
        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 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.

        Parameters:
        key - (undocumented)
        msg - (undocumented)
        interval - (undocumented)
      • startTimerWithFixedDelay

        public abstract void startTimerWithFixedDelay​(java.lang.Object key,
                                                      java.lang.Object msg,
                                                      scala.concurrent.duration.FiniteDuration delay)
      • startTimerWithFixedDelay

        public final void startTimerWithFixedDelay​(java.lang.Object key,
                                                   java.lang.Object msg,
                                                   java.time.Duration delay)
        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 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.

        Parameters:
        key - (undocumented)
        msg - (undocumented)
        delay - (undocumented)