reactor.timer

Class HashWheelTimer.TimerRegistration<T extends Consumer<java.lang.Long>>

java.lang.Object

reactor.timer.HashWheelTimer.TimerRegistration<T>

Type Parameters:

T - type of the Timer Registration Consumer

All Implemented Interfaces:

java.lang.Comparable, java.lang.Runnable, Pausable, Registration

Enclosing class:

HashWheelTimer

public static class HashWheelTimer.TimerRegistration<T extends Consumer<java.lang.Long>>
extends java.lang.Object
implements java.lang.Runnable, java.lang.Comparable, Pausable, Registration

Timer Registration

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_CANCELLED
static int	STATUS_PAUSED
static int	STATUS_READY

Constructor Summary

Constructors

Constructor and Description
TimerRegistration(long rounds, long offset, T delegate, long rescheduleRounds) Creates a new Timer Registration with given , and .

Method Summary

Modifier and Type	Method and Description
Registration	cancel() Cancel the registration
HashWheelTimer.TimerRegistration<T>	cancelAfterUse() Cancel this HashWheelTimer.TimerRegistration after it has been selected and used.
int	compareTo(java.lang.Object o)
void	decrement() Decrement an amount of runs Registration has to run until it's elapsed
java.lang.Object	getObject() The object that was registered
Selector	getSelector() The Selector that was used when the registration was made.
boolean	isCancelAfterUse() Whether to cancel this Registration after use or not.
boolean	isCancelled() Check whether the current Registration is cancelled
boolean	isPaused() Check whether the current Registration is paused
Registration	pause() Pause the current Regisration
boolean	ready() Check whether the current Registration is ready for execution
void	reset() Reset the Registration
Registration	resume() Resume current Registration
void	run() Run the delegate of the current Registration
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_PAUSED

public static int STATUS_PAUSED

STATUS_CANCELLED

public static int STATUS_CANCELLED

STATUS_READY

public static int STATUS_READY

Constructor Detail

TimerRegistration

public TimerRegistration(long rounds,
                         long offset,
                         T delegate,
                         long rescheduleRounds)

Creates a new Timer Registration with given , and .

Parameters:

rounds - amount of rounds the Registration should go through until it's elapsed

offset - offset of in the Ring Buffer for rescheduling

delegate - delegate that will be ran whenever the timer is elapsed

Method Detail

decrement

public void decrement()

Decrement an amount of runs Registration has to run until it's elapsed

ready

public boolean ready()

Check whether the current Registration is ready for execution

Returns:

whether or not the current Registration is ready for execution

run

public void run()

Run the delegate of the current Registration

Specified by:

run in interface java.lang.Runnable

reset

public void reset()

Reset the Registration

cancel

public Registration cancel()

Cancel the registration

Specified by:

cancel in interface Pausable

Specified by:

cancel in interface Registration

Returns:

current Registration

isCancelled

public boolean isCancelled()

Check whether the current Registration is cancelled

Specified by:

isCancelled in interface Registration

Returns:

whether or not the current Registration is cancelled

pause

public Registration pause()

Pause the current Regisration

Specified by:

pause in interface Pausable

Specified by:

pause in interface Registration

Returns:

current Registration

isPaused

public boolean isPaused()

Check whether the current Registration is paused

Specified by:

isPaused in interface Registration

Returns:

whether or not the current Registration is paused

resume

public Registration resume()

Resume current Registration

Specified by:

resume in interface Pausable

Specified by:

resume in interface Registration

Returns:

current Registration

getSelector

public Selector getSelector()

Description copied from interface: Registration

The Selector that was used when the registration was made.

Specified by:

getSelector in interface Registration

Returns:

the registration's selector

getObject

public java.lang.Object getObject()

Description copied from interface: Registration

The object that was registered

Specified by:

getObject in interface Registration

Returns:

the registered object

cancelAfterUse

public HashWheelTimer.TimerRegistration<T> cancelAfterUse()

Cancel this HashWheelTimer.TimerRegistration after it has been selected and used. Dispatcher implementations should respect this value and perform the cancellation.

Specified by:

cancelAfterUse in interface Registration

Returns:

this

isCancelAfterUse

public boolean isCancelAfterUse()

Description copied from interface: Registration

Whether to cancel this Registration after use or not.

Specified by:

isCancelAfterUse in interface Registration

Returns:

true if the registration will be cancelled after use, false otherwise.

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object