Package io.netty.util

Interface Timeout

All Known Implementing Classes:
HashedWheelTimer.HashedWheelTimeout

public interface Timeout
A handle associated with a TimerTask that is returned by a Timer.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Attempts to cancel the TimerTask associated with this handle.
    boolean
    Returns true if and only if the TimerTask associated with this handle has been cancelled.
    boolean
    Returns true if and only if the TimerTask associated with this handle has been expired.
    Returns the TimerTask which is associated with this handle.
    Returns the Timer that created this handle.
  • Method Details

    • timer

      Timer timer()
      Returns the Timer that created this handle.
    • task

      TimerTask task()
      Returns the TimerTask which is associated with this handle.
    • isExpired

      boolean isExpired()
      Returns true if and only if the TimerTask associated with this handle has been expired.
    • isCancelled

      boolean isCancelled()
      Returns true if and only if the TimerTask associated with this handle has been cancelled.
    • cancel

      boolean cancel()
      Attempts to cancel the TimerTask associated with this handle. If the task has been executed or cancelled already, it will return with no side effect.
      Returns:
      True if the cancellation completed successfully, otherwise false