Modifier and Type	Class and Description
private static class	HashedWheelTimer.HashedWheelBucket Bucket that stores HashedWheelTimeouts.
private static class	HashedWheelTimer.HashedWheelTimeout
private class	HashedWheelTimer.Worker

Modifier and Type	Field and Description
private final Queue<HashedWheelTimer.HashedWheelTimeout>	cancelledTimeouts
private static final int	INSTANCE_COUNT_LIMIT
private static final AtomicInteger	INSTANCE_COUNTER
private final ResourceLeakTracker<HashedWheelTimer>	leak
private static final ResourceLeakDetector<HashedWheelTimer>	leakDetector
pack-priv static final InternalLogger	logger
private final int	mask
private final long	maxPendingTimeouts
private static final long	MILLISECOND_NANOS
private final AtomicLong	pendingTimeouts
private volatile long	startTime
private final CountDownLatch	startTimeInitialized
private final Executor	taskExecutor
private final long	tickDuration
private final Queue<HashedWheelTimer.HashedWheelTimeout>	timeouts
private static final AtomicBoolean	WARNED_TOO_MANY_INSTANCES
private final HashedWheelTimer.HashedWheelBucket[]	wheel
private final HashedWheelTimer.Worker	worker
public static final int	WORKER_STATE_INIT
public static final int	WORKER_STATE_SHUTDOWN
public static final int	WORKER_STATE_STARTED
private static final AtomicIntegerFieldUpdater<HashedWheelTimer>	WORKER_STATE_UPDATER
private volatile int	workerState
private final Thread	workerThread

Constructor Summary

Access	Constructor and Description
public	HashedWheelTimer() Creates a new timer with the default thread factory (`Executors#defaultThreadFactory()`), default tick duration, and default number of ticks per wheel.
public	HashedWheelTimer(long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit) Creates a new timer with the default thread factory (`Executors#defaultThreadFactory()`) and default number of ticks per wheel.
public	HashedWheelTimer(long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit, int the size of the wheel ticksPerWheel) Creates a new timer with the default thread factory (`Executors#defaultThreadFactory()`).
public	HashedWheelTimer(ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. threadFactory) Creates a new timer with the default tick duration and default number of ticks per wheel.
public	HashedWheelTimer(ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. threadFactory, long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit) Creates a new timer with the default number of ticks per wheel.
public	HashedWheelTimer(ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. threadFactory, long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit, int the size of the wheel ticksPerWheel) Creates a new timer.
public	HashedWheelTimer(ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. threadFactory, long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit, int the size of the wheel ticksPerWheel, boolean `true` if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread. leakDetection) Creates a new timer.
public	HashedWheelTimer(ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. threadFactory, long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit, int the size of the wheel ticksPerWheel, boolean `true` if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread. leakDetection, long The maximum number of pending timeouts after which call to `newTimeout` will result in `java.util.concurrent.RejectedExecutionException` being thrown. No maximum pending timeouts limit is assumed if this value is 0 or negative. maxPendingTimeouts) Creates a new timer.
public	HashedWheelTimer(ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. threadFactory, long the duration between tick tickDuration, TimeUnit the time unit of the `tickDuration` unit, int the size of the wheel ticksPerWheel, boolean `true` if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread. leakDetection, long The maximum number of pending timeouts after which call to `newTimeout` will result in `java.util.concurrent.RejectedExecutionException` being thrown. No maximum pending timeouts limit is assumed if this value is 0 or negative. maxPendingTimeouts, Executor The `Executor` that is used to execute the submitted `TimerTask`s. The caller is responsible to shutdown the `Executor` once it is not needed anymore. taskExecutor) Creates a new timer.

Method Summary

Modifier and Type	Method and Description
private static HashedWheelTimer.HashedWheelBucket[]	createWheel(int ticksPerWheel)
protected void	finalize() Overrides java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
public Timeout	newTimeout(TimerTask task, long delay, TimeUnit unit) Implements io.netty5.util.Timer.newTimeout. Schedules the specified `TimerTask` for one-time execution after the specified delay.
private static int	normalizeTicksPerWheel(int ticksPerWheel)
public long	pendingTimeouts() Returns the number of pending timeouts of this `Timer`.
private static void	reportTooManyInstances()
public void	start() Starts the background thread explicitly.
public Set<Timeout>	stop() Implements io.netty5.util.Timer.stop. Releases all resources acquired by this `Timer` and cancels all tasks which were scheduled but not executed yet.

Inherited from java.lang.Object:: clone equals getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancelledTimeouts	back to summary
private final Queue<HashedWheelTimer.HashedWheelTimeout> cancelledTimeouts

INSTANCE_COUNT_LIMIT	back to summary
private static final int INSTANCE_COUNT_LIMIT

INSTANCE_COUNTER	back to summary
private static final AtomicInteger INSTANCE_COUNTER

leak	back to summary
private final ResourceLeakTracker<HashedWheelTimer> leak

leakDetector	back to summary
private static final ResourceLeakDetector<HashedWheelTimer> leakDetector

logger	back to summary
pack-priv static final InternalLogger logger

mask	back to summary
private final int mask

maxPendingTimeouts	back to summary
private final long maxPendingTimeouts

MILLISECOND_NANOS	back to summary
private static final long MILLISECOND_NANOS

pendingTimeouts	back to summary
private final AtomicLong pendingTimeouts

startTime	back to summary
private volatile long startTime

startTimeInitialized	back to summary
private final CountDownLatch startTimeInitialized

taskExecutor	back to summary
private final Executor taskExecutor

tickDuration	back to summary
private final long tickDuration

timeouts	back to summary
private final Queue<HashedWheelTimer.HashedWheelTimeout> timeouts

WARNED_TOO_MANY_INSTANCES	back to summary
private static final AtomicBoolean WARNED_TOO_MANY_INSTANCES

wheel	back to summary
private final HashedWheelTimer.HashedWheelBucket[] wheel

worker	back to summary
private final HashedWheelTimer.Worker worker

WORKER_STATE_INIT	back to summary
public static final int WORKER_STATE_INIT

WORKER_STATE_SHUTDOWN	back to summary
public static final int WORKER_STATE_SHUTDOWN

WORKER_STATE_STARTED	back to summary
public static final int WORKER_STATE_STARTED

WORKER_STATE_UPDATER	back to summary
private static final AtomicIntegerFieldUpdater<HashedWheelTimer> WORKER_STATE_UPDATER

workerState	back to summary
private volatile int workerState Annotations @SuppressWarnings:unused, FieldMayBeFinal

workerThread	back to summary
private final Thread workerThread

Constructor Detail

HashedWheelTimer	back to summary
public HashedWheelTimer() Creates a new timer with the default thread factory (`Executors#defaultThreadFactory()`), default tick duration, and default number of ticks per wheel.

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(long tickDuration, TimeUnit unit) Creates a new timer with the default thread factory (`Executors#defaultThreadFactory()`) and default number of ticks per wheel. Parameters tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` Exceptions NullPointerException: if `unit` is `null` IllegalArgumentException: if `tickDuration` is <= 0

public HashedWheelTimer(long tickDuration, TimeUnit unit)

Creates a new timer with the default thread factory (Executors#defaultThreadFactory()) and default number of ticks per wheel.

Parameters

tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration

Exceptions

NullPointerException:: if unit is null
IllegalArgumentException:: if tickDuration is <= 0

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(long tickDuration, TimeUnit unit, int ticksPerWheel) Creates a new timer with the default thread factory (`Executors#defaultThreadFactory()`). Parameters tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` ticksPerWheel:int the size of the wheel Exceptions NullPointerException: if `unit` is `null` IllegalArgumentException: if either of `tickDuration` and `ticksPerWheel` is <= 0

public HashedWheelTimer(long tickDuration, TimeUnit unit, int ticksPerWheel)

Creates a new timer with the default thread factory (Executors#defaultThreadFactory()).

Parameters

tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration
ticksPerWheel:int: the size of the wheel

Exceptions

NullPointerException:: if unit is null
IllegalArgumentException:: if either of tickDuration and ticksPerWheel is <= 0

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(ThreadFactory threadFactory) Creates a new timer with the default tick duration and default number of ticks per wheel. Parameters threadFactory:ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. Exceptions NullPointerException: if `threadFactory` is `null`

public HashedWheelTimer(ThreadFactory threadFactory)

Creates a new timer with the default tick duration and default number of ticks per wheel.

Parameters

threadFactory:ThreadFactory: a ThreadFactory that creates a background Thread which is dedicated to TimerTask execution.

Exceptions

NullPointerException:: if threadFactory is null

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit) Creates a new timer with the default number of ticks per wheel. Parameters threadFactory:ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` Exceptions NullPointerException: if either of `threadFactory` and `unit` is `null` IllegalArgumentException: if `tickDuration` is <= 0

public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit)

Creates a new timer with the default number of ticks per wheel.

Parameters

threadFactory:ThreadFactory: a ThreadFactory that creates a background Thread which is dedicated to TimerTask execution.
tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration

Exceptions

NullPointerException:: if either of threadFactory and unit is null
IllegalArgumentException:: if tickDuration is <= 0

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel) Creates a new timer. Parameters threadFactory:ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` ticksPerWheel:int the size of the wheel Exceptions NullPointerException: if either of `threadFactory` and `unit` is `null` IllegalArgumentException: if either of `tickDuration` and `ticksPerWheel` is <= 0

public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel)

Creates a new timer.

Parameters

threadFactory:ThreadFactory: a ThreadFactory that creates a background Thread which is dedicated to TimerTask execution.
tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration
ticksPerWheel:int: the size of the wheel

Exceptions

NullPointerException:: if either of threadFactory and unit is null
IllegalArgumentException:: if either of tickDuration and ticksPerWheel is <= 0

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection) Creates a new timer. Parameters threadFactory:ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` ticksPerWheel:int the size of the wheel leakDetection:boolean `true` if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread. Exceptions NullPointerException: if either of `threadFactory` and `unit` is `null` IllegalArgumentException: if either of `tickDuration` and `ticksPerWheel` is <= 0

public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection)

Creates a new timer.

Parameters

threadFactory:ThreadFactory: a ThreadFactory that creates a background Thread which is dedicated to TimerTask execution.
tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration
ticksPerWheel:int: the size of the wheel
leakDetection:boolean: true if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread.

Exceptions

NullPointerException:: if either of threadFactory and unit is null
IllegalArgumentException:: if either of tickDuration and ticksPerWheel is <= 0

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection, long maxPendingTimeouts) Creates a new timer. Parameters threadFactory:ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` ticksPerWheel:int the size of the wheel leakDetection:boolean `true` if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread. maxPendingTimeouts:long The maximum number of pending timeouts after which call to `newTimeout` will result in `java.util.concurrent.RejectedExecutionException` being thrown. No maximum pending timeouts limit is assumed if this value is 0 or negative. Exceptions NullPointerException: if either of `threadFactory` and `unit` is `null` IllegalArgumentException: if either of `tickDuration` and `ticksPerWheel` is <= 0

public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection, long maxPendingTimeouts)

Creates a new timer.

Parameters

threadFactory:ThreadFactory: a ThreadFactory that creates a background Thread which is dedicated to TimerTask execution.
tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration
ticksPerWheel:int: the size of the wheel
leakDetection:boolean: true if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread.
maxPendingTimeouts:long: The maximum number of pending timeouts after which call to newTimeout will result in java.util.concurrent.RejectedExecutionException being thrown. No maximum pending timeouts limit is assumed if this value is 0 or negative.

Exceptions

NullPointerException:: if either of threadFactory and unit is null
IllegalArgumentException:: if either of tickDuration and ticksPerWheel is <= 0

HashedWheelTimer back to summary

HashedWheelTimer	back to summary
public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection, long maxPendingTimeouts, Executor taskExecutor) Creates a new timer. Parameters threadFactory:ThreadFactory a `ThreadFactory` that creates a background `Thread` which is dedicated to `TimerTask` execution. tickDuration:long the duration between tick unit:TimeUnit the time unit of the `tickDuration` ticksPerWheel:int the size of the wheel leakDetection:boolean `true` if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread. maxPendingTimeouts:long The maximum number of pending timeouts after which call to `newTimeout` will result in `java.util.concurrent.RejectedExecutionException` being thrown. No maximum pending timeouts limit is assumed if this value is 0 or negative. taskExecutor:Executor The `Executor` that is used to execute the submitted `TimerTask`s. The caller is responsible to shutdown the `Executor` once it is not needed anymore. Exceptions NullPointerException: if either of `threadFactory` and `unit` is `null` IllegalArgumentException: if either of `tickDuration` and `ticksPerWheel` is <= 0

public HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection, long maxPendingTimeouts, Executor taskExecutor)

Creates a new timer.

Parameters

threadFactory:ThreadFactory: a ThreadFactory that creates a background Thread which is dedicated to TimerTask execution.
tickDuration:long: the duration between tick
unit:TimeUnit: the time unit of the tickDuration
ticksPerWheel:int: the size of the wheel
leakDetection:boolean: true if leak detection should be enabled always, if false it will only be enabled if the worker thread is not a daemon thread.
maxPendingTimeouts:long: The maximum number of pending timeouts after which call to newTimeout will result in java.util.concurrent.RejectedExecutionException being thrown. No maximum pending timeouts limit is assumed if this value is 0 or negative.
taskExecutor:Executor: The Executor that is used to execute the submitted TimerTasks. The caller is responsible to shutdown the Executor once it is not needed anymore.

Exceptions

NullPointerException:: if either of threadFactory and unit is null
IllegalArgumentException:: if either of tickDuration and ticksPerWheel is <= 0

Method Detail

createWheel	back to summary
private static HashedWheelTimer.HashedWheelBucket[] createWheel(int ticksPerWheel)

finalize back to summary

finalize	back to summary
protected void finalize() throws Throwable Overrides java.lang.Object.finalize. Doc from java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call `finalize()`. In a Java virtual machine in which finalization is enabled, the garbage collector might call `finalize` only after an indefinite delay. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored. Annotations @Override Exceptions Throwable: the `Exception` raised by this method

protected void finalize() throws Throwable

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Annotations

@Override

Exceptions

Throwable:: the Exception raised by this method

newTimeout back to summary

newTimeout	back to summary
public Timeout newTimeout(TimerTask task, long delay, TimeUnit unit) Implements io.netty5.util.Timer.newTimeout. Doc from io.netty5.util.Timer.newTimeout. Schedules the specified `TimerTask` for one-time execution after the specified delay. Returns:Timeout a handle which is associated with the specified task Annotations @Override

public Timeout newTimeout(TimerTask task, long delay, TimeUnit unit)

Implements io.netty5.util.Timer.newTimeout.

Doc from io.netty5.util.Timer.newTimeout.

Schedules the specified TimerTask for one-time execution after the specified delay.

Returns:Timeout

a handle which is associated with the specified task

Annotations

@Override

normalizeTicksPerWheel	back to summary
private static int normalizeTicksPerWheel(int ticksPerWheel)

pendingTimeouts	back to summary
public long pendingTimeouts() Returns the number of pending timeouts of this `Timer`.

reportTooManyInstances	back to summary
private static void reportTooManyInstances()

start	back to summary
public void start() Starts the background thread explicitly. The background thread will start automatically on demand even if you did not call this method. Exceptions IllegalStateException: if this timer has been stopped already

start

back to summary

public void start()

Starts the background thread explicitly. The background thread will start automatically on demand even if you did not call this method.

Exceptions

IllegalStateException:: if this timer has been stopped already

stop back to summary

stop	back to summary
public Set<Timeout> stop() Implements io.netty5.util.Timer.stop. Doc from io.netty5.util.Timer.stop. Releases all resources acquired by this `Timer` and cancels all tasks which were scheduled but not executed yet. Returns:Set<Timeout> the handles associated with the tasks which were canceled by this method Annotations @Override

public Set<Timeout> stop()

Implements io.netty5.util.Timer.stop.

Doc from io.netty5.util.Timer.stop.

Releases all resources acquired by this Timer and cancels all tasks which were scheduled but not executed yet.

Returns:Set<Timeout>

the handles associated with the tasks which were canceled by this method

Annotations

@Override

io.netty5.util back to summary

private final Class HashedWheelTimer.HashedWheelBucket

Class Inheritance

extends Object

java.lang.Object
io.netty5.util.HashedWheelTimer.HashedWheelBucket

Bucket that stores HashedWheelTimeouts. These are stored in a linked-list like datastructure to allow easy removal of HashedWheelTimeouts in the middle. Also the HashedWheelTimeout act as nodes themself and so no extra object creation is needed.

Field Summary

Modifier and Type	Field and Description
private HashedWheelTimer.HashedWheelTimeout	head
private HashedWheelTimer.HashedWheelTimeout	tail

Constructor Summary

Access	Constructor and Description
private	HashedWheelBucket()

Method Summary

Modifier and Type	Method and Description
public void	addTimeout(HashedWheelTimer.HashedWheelTimeout timeout) Add `HashedWheelTimeout` to this bucket.
public void	clearTimeouts(Set<Timeout> set) Clear this bucket and return all not expired / cancelled `Timeout`s.
public void	expireTimeouts(long deadline) Expire all `HashedWheelTimeout`s for the given `deadline`.
private HashedWheelTimer.HashedWheelTimeout	pollTimeout()
public HashedWheelTimer.HashedWheelTimeout	remove(HashedWheelTimer.HashedWheelTimeout timeout)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

head	back to summary
private HashedWheelTimer.HashedWheelTimeout head

tail	back to summary
private HashedWheelTimer.HashedWheelTimeout tail

Constructor Detail

HashedWheelBucket	back to summary
private HashedWheelBucket()

Method Detail

addTimeout	back to summary
public void addTimeout(HashedWheelTimer.HashedWheelTimeout timeout) Add `HashedWheelTimeout` to this bucket.

clearTimeouts	back to summary
public void clearTimeouts(Set<Timeout> set) Clear this bucket and return all not expired / cancelled `Timeout`s.

expireTimeouts	back to summary
public void expireTimeouts(long deadline) Expire all `HashedWheelTimeout`s for the given `deadline`.

pollTimeout	back to summary
private HashedWheelTimer.HashedWheelTimeout pollTimeout()

remove	back to summary
public HashedWheelTimer.HashedWheelTimeout remove(HashedWheelTimer.HashedWheelTimeout timeout)

io.netty5.util back to summary

private final Class HashedWheelTimer.HashedWheelTimeout

Class Inheritance

extends Object
implements Timeout, Runnable

java.lang.Object
io.netty5.util.HashedWheelTimer.HashedWheelTimeout

All Implemented Interfaces

java.lang.Runnable, io.netty5.util.Timeout

Field Summary

Modifier and Type	Field and Description
pack-priv HashedWheelTimer.HashedWheelBucket	bucket
private final long	deadline
pack-priv HashedWheelTimer.HashedWheelTimeout	next
pack-priv HashedWheelTimer.HashedWheelTimeout	prev
pack-priv long	remainingRounds
private static final int	ST_CANCELLED
private static final int	ST_EXPIRED
private static final int	ST_INIT
private volatile int	state
private static final AtomicIntegerFieldUpdater<HashedWheelTimer.HashedWheelTimeout>	STATE_UPDATER
private final TimerTask	task
private final HashedWheelTimer	timer

Constructor Summary

Access	Constructor and Description
pack-priv	HashedWheelTimeout(HashedWheelTimer timer, TimerTask task, long deadline)

Method Summary

Modifier and Type	Method and Description
public boolean	cancel() Implements io.netty5.util.Timeout.cancel. Attempts to cancel the `TimerTask` associated with this handle.
public boolean	compareAndSetState(int expected, int state)
public void	expire()
public boolean	isCancelled() Implements io.netty5.util.Timeout.isCancelled. Returns `true` if and only if the `TimerTask` associated with this handle has been cancelled.
public boolean	isExpired() Implements io.netty5.util.Timeout.isExpired. Returns `true` if and only if the `TimerTask` associated with this handle has been expired.
pack-priv void	remove()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public int	state()
public TimerTask	task() Implements io.netty5.util.Timeout.task. Returns the `TimerTask` which is associated with this handle.
public Timer	timer() Implements io.netty5.util.Timeout.timer. Returns the `Timer` that created this handle.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

bucket	back to summary
pack-priv HashedWheelTimer.HashedWheelBucket bucket

deadline	back to summary
private final long deadline

next	back to summary
pack-priv HashedWheelTimer.HashedWheelTimeout next

prev	back to summary
pack-priv HashedWheelTimer.HashedWheelTimeout prev

remainingRounds	back to summary
pack-priv long remainingRounds

ST_CANCELLED	back to summary
private static final int ST_CANCELLED

ST_EXPIRED	back to summary
private static final int ST_EXPIRED

ST_INIT	back to summary
private static final int ST_INIT

state	back to summary
private volatile int state Annotations @SuppressWarnings:unused, FieldMayBeFinal, RedundantFieldInitialization

STATE_UPDATER	back to summary
private static final AtomicIntegerFieldUpdater<HashedWheelTimer.HashedWheelTimeout> STATE_UPDATER

task	back to summary
private final TimerTask task

timer	back to summary
private final HashedWheelTimer timer

Constructor Detail

HashedWheelTimeout	back to summary
pack-priv HashedWheelTimeout(HashedWheelTimer timer, TimerTask task, long deadline)

Method Detail

cancel back to summary

public boolean cancel()

Implements io.netty5.util.Timeout.cancel.

Doc from io.netty5.util.Timeout.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

Annotations

@Override

compareAndSetState	back to summary
public boolean compareAndSetState(int expected, int state)

expire	back to summary
public void expire()

isCancelled back to summary

public boolean isCancelled()

Implements io.netty5.util.Timeout.isCancelled.

Doc from io.netty5.util.Timeout.isCancelled.

Returns true if and only if the TimerTask associated with this handle has been cancelled.

Annotations

@Override

isExpired back to summary

public boolean isExpired()

Implements io.netty5.util.Timeout.isExpired.

Doc from io.netty5.util.Timeout.isExpired.

Returns true if and only if the TimerTask associated with this handle has been expired.

Annotations

@Override

remove	back to summary
pack-priv void remove()

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

state	back to summary
public int state()

task back to summary

public TimerTask task()

Implements io.netty5.util.Timeout.task.

Doc from io.netty5.util.Timeout.task.

Returns the TimerTask which is associated with this handle.

Annotations

@Override

timer back to summary

public Timer timer()

Implements io.netty5.util.Timeout.timer.

Doc from io.netty5.util.Timeout.timer.

Returns the Timer that created this handle.

Annotations

@Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

Modifier and Type	Method and Description
private void	processCancelledTasks()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	transferTimeoutsToBuckets()
public Set<Timeout>	unprocessedTimeouts()
private long	Returns: Long.MIN_VALUE if received a shutdown request, current time otherwise (with Long.MIN_VALUE changed by +1) waitForNextTick() calculate goal nanoTime from startTime and current tick number, then wait until that goal has been reached.

public Class HashedWheelTimer

Tick Duration

Ticks per Wheel (Wheel Size)

Do not create many instances.

Implementation Details

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HashedWheelTimer.HashedWheelBucket

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HashedWheelTimer.HashedWheelTimeout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HashedWheelTimer.Worker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private long	tick
private final Set<Timeout>	unprocessedTimeouts