Top Description Methods

io.netty.util

public Interface Timeout

Known Direct Implementers: io.netty.util.HashedWheelTimer.HashedWheelTimeout

A handle associated with a TimerTask that is returned by a Timer.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: True if the cancellation completed successfully, otherwise false cancel() Attempts to cancel the `TimerTask` associated with this handle.
public boolean	isCancelled() Returns `true` if and only if the `TimerTask` associated with this handle has been cancelled.
public boolean	isExpired() Returns `true` if and only if the `TimerTask` associated with this handle has been expired.
public TimerTask	task() Returns the `TimerTask` which is associated with this handle.
public Timer	timer() Returns the `Timer` that created this handle.

Method Detail

cancel back to summary

public 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:boolean: True if the cancellation completed successfully, otherwise false

isCancelled	back to summary
public boolean isCancelled() Returns `true` if and only if the `TimerTask` associated with this handle has been cancelled.

isExpired	back to summary
public boolean isExpired() Returns `true` if and only if the `TimerTask` associated with this handle has been expired.

task	back to summary
public TimerTask task() Returns the `TimerTask` which is associated with this handle.

timer	back to summary
public Timer timer() Returns the `Timer` that created this handle.