Module org.snmp4j

Interface CommonTimer


  • public interface CommonTimer
    This CommonTimer defines the subset interface used from Timer by SNMP4J.
    Since:
    1.9
    Version:
    1.9
    Author:
    Frank Fock
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancel()
      Terminates this timer, discarding any currently scheduled tasks.
      void schedule​(java.util.TimerTask task, long delay)
      Schedules the specified task for execution after the specified delay.
      void schedule​(java.util.TimerTask task, long delay, long period)
      Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay.
      void schedule​(java.util.TimerTask task, java.util.Date firstTime, long period)
      Schedules the specified task for repeated fixed-delay execution, beginning at the specified time.
    • Method Detail

      • schedule

        void schedule​(java.util.TimerTask task,
                      long delay)
        Schedules the specified task for execution after the specified delay.
        Parameters:
        task - task to be scheduled.
        delay - delay in milliseconds before task is to be executed.
        Throws:
        java.lang.IllegalArgumentException - if delay is negative, or delay + System.currentTimeMillis() is negative.
        java.lang.IllegalStateException - if task was already scheduled or cancelled, or timer was cancelled.
      • schedule

        void schedule​(java.util.TimerTask task,
                      java.util.Date firstTime,
                      long period)
        Schedules the specified task for repeated fixed-delay execution, beginning at the specified time. Subsequent executions take place at approximately regular intervals, separated by the specified period.

        In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate).

        Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.

        Parameters:
        task - task to be scheduled.
        firstTime - First time at which task is to be executed.
        period - time in milliseconds between successive task executions.
        Throws:
        java.lang.IllegalArgumentException - if time.getTime() is negative.
        java.lang.IllegalStateException - if task was already scheduled or cancelled, timer was cancelled, or timer thread terminated.
      • schedule

        void schedule​(java.util.TimerTask task,
                      long delay,
                      long period)
        Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals separated by the specified period.

        In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate).

        Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.

        Parameters:
        task - task to be scheduled.
        delay - delay in milliseconds before task is to be executed.
        period - time in milliseconds between successive task executions.
        Throws:
        java.lang.IllegalArgumentException - if delay is negative, or delay + System.currentTimeMillis() is negative.
        java.lang.IllegalStateException - if task was already scheduled or cancelled, timer was cancelled, or timer thread terminated.
      • cancel

        void cancel()
        Terminates this timer, discarding any currently scheduled tasks. Does not interfere with a currently executing task (if it exists). Once a timer has been terminated, its execution thread terminates gracefully, and no more tasks may be scheduled on it.

        Note that calling this method from within the run method of a timer task that was invoked by this timer absolutely guarantees that the ongoing task execution is the last task execution that will ever be performed by this timer.

        This method may be called repeatedly; the second and subsequent calls have no effect.