Class TimeoutTask

Method Details

• scheduledExecutionTime

  public long scheduledExecutionTime()

  Returns the scheduled execution time of the most recent actual execution of this task. (If this method is invoked while task execution is in progress, the return value is the scheduled execution time of the ongoing task execution.)

  This method is typically invoked from within a task's run method, to determine whether the current execution of the task is sufficiently timely to warrant performing the scheduled activity:

  
     public void run() {
         if (System.currentTimeMillis() - scheduledExecutionTime() >=
             MAX_TARDINESS)
                 return;  // Too late; skip this execution.
         // Perform the task
     }
   

  This method is typically not used in conjunction with fixed-delay execution repeating tasks, as their scheduled execution times are allowed to drift over time, and so are not terribly significant.

  Returns:

  the time at which the most recent execution of this task was scheduled to occur, in the format returned by Date.getTime(). The return value is undefined if the task has yet to commence its first execution.

  See Also:

  • Date.getTime()

• isCanceled

  public boolean isCanceled()

  Checks if the task is canceled.

  Specified by:

  isCanceled in interface ITimeoutTask

  Returns:

  The canceled flag.

• getStartTime

  public long getStartTime()

  Gets the starting time.

  Returns the starting time in milliseconds. Note that while the unit of time of the return value is a millisecond, the granularity of the value depends on the underlying operating system and may be larger. For example, many operating systems measure time in units of tens of milliseconds.

  See the description of the class Date for a discussion of slight discrepancies that may arise between "computer time" and coordinated universal time (UTC).

  Specified by:

  getStartTime in interface ITimerTask

  Returns:

  The difference, measured in milliseconds, between the start time and midnight, January 1, 1970 UTC.

  See Also:

  • Date

• getRemainingTime

  public long getRemainingTime()

  Gets the remaining time before timeout. This value just keeps on counting, even when the timeout has occurred or the task is stopped.

  Specified by:

  getRemainingTime in interface ITimeoutTask

  Returns:

  A time in milliseconds >= zero indicating the remaining timeout time, or < zero if the task has timed out. The return value is Long.MAX_VALUE if the timeout is indefinite.

• hasTimedOut

  public boolean hasTimedOut()

  Verifies if timeout has occurred.

  Specified by:

  hasTimedOut in interface ITimeoutTask

  Returns:

  true if the task has timed out, false otherwise.

• hasNotifiedTimeout

  public boolean hasNotifiedTimeout()

  Returns whether timeout notification has been called or not.

  Specified by:

  hasNotifiedTimeout in interface ITimeoutTask

  Returns:

  true if the timeout task has been notified, false otherwise (e.g. task canceled).

• cancel

  public boolean cancel()

  Cancels the timeout task. This call can be done from any thread and will stop any timeout notification of ITimeoutListener.onTimeout().

  Specified by:

  cancel in interface ITimerTask

  Returns:

  true for success, false if already canceled.