Package akka.actor

Class TimerSchedulerImpl

    • Constructor Detail

      • TimerSchedulerImpl

        public TimerSchedulerImpl​(ActorContext ctx)
    • Method Detail

      • startTimerAtFixedRate

        public void startTimerAtFixedRate​(java.lang.Object key,
                                          java.lang.Object msg,
                                          scala.concurrent.duration.FiniteDuration interval)
        Description copied from class: TimerScheduler
        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.

        Specified by:
        startTimerAtFixedRate in class TimerScheduler
        Parameters:
        key - (undocumented)
        msg - (undocumented)
        interval - (undocumented)
      • startTimerWithFixedDelay

        public void startTimerWithFixedDelay​(java.lang.Object key,
                                             java.lang.Object msg,
                                             scala.concurrent.duration.FiniteDuration delay)
        Specified by:
        startTimerWithFixedDelay in class TimerScheduler
      • startSingleTimer

        public void startSingleTimer​(java.lang.Object key,
                                     java.lang.Object msg,
                                     scala.concurrent.duration.FiniteDuration timeout)
        Description copied from class: TimerScheduler
        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.

        Specified by:
        startSingleTimer in class TimerScheduler
        Parameters:
        key - (undocumented)
        msg - (undocumented)
        timeout - (undocumented)
      • isTimerActive

        public boolean isTimerActive​(java.lang.Object key)
        Description copied from class: TimerScheduler
        Check if a timer with a given key is active.
        Specified by:
        isTimerActive in class TimerScheduler
        Parameters:
        key - (undocumented)
        Returns:
        (undocumented)
      • cancel

        public void cancel​(java.lang.Object key)
        Description copied from class: TimerScheduler
        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.

        Specified by:
        cancel in class TimerScheduler
        Parameters:
        key - (undocumented)