Package io.netty.util
Interface Timeout
- All Known Implementing Classes:
HashedWheelTimer.HashedWheelTimeout
public interface Timeout
-
Method Summary
Modifier and TypeMethodDescriptionboolean
cancel()
Attempts to cancel theTimerTask
associated with this handle.boolean
Returnstrue
if and only if theTimerTask
associated with this handle has been cancelled.boolean
Returnstrue
if and only if theTimerTask
associated with this handle has been expired.task()
Returns theTimerTask
which is associated with this handle.timer()
Returns theTimer
that created this handle.
-
Method Details
-
timer
Timer timer()Returns theTimer
that created this handle. -
task
TimerTask task()Returns theTimerTask
which is associated with this handle. -
isExpired
boolean isExpired()Returnstrue
if and only if theTimerTask
associated with this handle has been expired. -
isCancelled
boolean isCancelled()Returnstrue
if and only if theTimerTask
associated with this handle has been cancelled. -
cancel
boolean cancel()Attempts to cancel theTimerTask
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
-