reactor.event.registry

Interface Registration<T>

Type Parameters:

T - The type of object that is registered

All Superinterfaces:

Pausable

All Known Implementing Classes:

CachableRegistration, HashWheelTimer.TimerRegistration

public interface Registration<T>
extends Pausable

A Registration represents an object that has been registered with a Registry.

Method Summary

Modifier and Type	Method and Description
Registration<T>	cancel() Cancel this Registration by removing it from its registry.
Registration<T>	cancelAfterUse() Cancel this Registration after it has been selected and used.
T	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() Has this been cancelled?
boolean	isPaused() Whether this Registration has been paused or not.
Registration<T>	pause() Pause this Registration.
Registration<T>	resume() Unpause this Registration, making it available for selection.

Method Detail

getSelector

Selector getSelector()

The Selector that was used when the registration was made.

Returns:

the registration's selector

getObject

T getObject()

The object that was registered

Returns:

the registered object

cancelAfterUse

Registration<T> cancelAfterUse()

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

Returns:

this

isCancelAfterUse

boolean isCancelAfterUse()

Whether to cancel this Registration after use or not.

Returns:

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

cancel

Registration<T> cancel()

Cancel this Registration by removing it from its registry.

Specified by:

cancel in interface Pausable

Returns:

this

isCancelled

boolean isCancelled()

Has this been cancelled?

Returns:

true if this has been cancelled, false otherwise.

pause

Registration<T> pause()

Pause this Registration. This leaves it in its registry but, while it is paused, it will not be eligible for selection.

Specified by:

pause in interface Pausable

Returns:

this

isPaused

boolean isPaused()

Whether this Registration has been paused or not.

Returns:

true if currently paused, false otherwise.

resume

Registration<T> resume()

Unpause this Registration, making it available for selection.

Specified by:

resume in interface Pausable

Returns:

this