Interface IoEventLoop

All Superinterfaces:

EventExecutor, EventExecutorGroup, EventLoop, EventLoopGroup, Executor, ExecutorService, IoEventLoopGroup, Iterable<EventExecutor>, OrderedEventExecutor, ScheduledExecutorService, ThreadAwareExecutor

All Known Implementing Classes:

EpollEventLoop, ManualIoEventLoop, NioEventLoop, SingleThreadIoEventLoop

public interface IoEventLoop
extends EventLoop, IoEventLoopGroup

EventLoop that allows to register / deregister IoHandle instances.

Method Summary

Modifier and Type	Method	Description
boolean	isCompatible(Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoEventLoopGroup and so can be registered to the contained IoEventLoops, false otherwise.
boolean	isIoType(Class<? extends IoHandler> handlerType)	Returns true if the given IoHandler type is used by this IoEventLoopGroup, false otherwise.
default IoEventLoop	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.
Future<IoRegistration>	register(IoHandle handle)	Register the IoHandle to the EventLoop for I/O processing.

Methods inherited from interface EventExecutor

inEventLoop, inEventLoop, isExecutorThread, isSuspended, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, trySuspend

Modifier and Type	Method	Description
default boolean	inEventLoop()	Calls EventExecutor.inEventLoop(Thread) with Thread.currentThread() as argument
boolean	inEventLoop(Thread thread)	Return true if the given Thread is executed in the event loop, false otherwise.
default boolean	isExecutorThread(Thread thread)	Return true if the given Thread is used by this ThreadAwareExecutor to execute work.
default boolean	isSuspended()	Returns true if the EventExecutor is considered suspended.
default <V> Future<V>	newFailedFuture(Throwable cause)	Create a new Future which is marked as failed already.
default <V> ProgressivePromise<V>	newProgressivePromise()	Create a new ProgressivePromise.
default <V> Promise<V>	newPromise()	Return a new Promise.
default <V> Future<V>	newSucceededFuture(V result)	Create a new Future which is marked as succeeded already.
default boolean	trySuspend()	Try to suspend this EventExecutor and return true if suspension was successful.

Methods inherited from interface EventExecutorGroup

isShuttingDown, iterator, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdown, shutdownGracefully, shutdownGracefully, shutdownNow, submit, submit, submit, terminationFuture, ticker

Modifier and Type	Method	Description
boolean	isShuttingDown()	Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.
Iterator<EventExecutor>	iterator()
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
void	shutdown()	Deprecated. EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) or EventExecutorGroup.shutdownGracefully() instead.
Future<?>	shutdownGracefully()	Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)	Signals this executor that the caller wants the executor to be shut down.
List<Runnable>	shutdownNow()	Deprecated. EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) or EventExecutorGroup.shutdownGracefully() instead.
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)
Future<?>	terminationFuture()	Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.
default Ticker	ticker()	The ticker for this executor.

Methods inherited from interface EventLoop

parent

Modifier and Type	Method	Description
EventLoopGroup	parent()	Return the EventExecutorGroup which is the parent of this EventExecutor,

Methods inherited from interface EventLoopGroup

register

Modifier and Type	Method	Description
ChannelFuture	register(Channel channel, ChannelPromise promise)	Deprecated. Use EventLoopGroup.register(ChannelPromise) instead.

Methods inherited from interface Executor

execute

Methods inherited from interface ExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated

Methods inherited from interface IoEventLoopGroup

register, register

Modifier and Type	Method	Description
default ChannelFuture	register(Channel channel)	Deprecated. Use IoEventLoopGroup.register(IoHandle)
default ChannelFuture	register(ChannelPromise promise)	Deprecated. Use IoEventLoopGroup.register(IoHandle)

Methods inherited from interface Iterable

forEach, spliterator

Method Details

next

default IoEventLoop next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors managed by this EventExecutorGroup.

Specified by:

next in interface EventExecutorGroup

Specified by:

next in interface EventLoopGroup

Specified by:

next in interface IoEventLoopGroup

register

Future<IoRegistration> register(IoHandle handle)

Register the IoHandle to the EventLoop for I/O processing.

Specified by:

register in interface IoEventLoopGroup

Parameters:

handle - the IoHandle to register.

Returns:

the Future that is notified once the operations completes.

isCompatible

boolean isCompatible(Class<? extends IoHandle> handleType)

Description copied from interface: IoEventLoopGroup

Returns true if the given type is compatible with this IoEventLoopGroup and so can be registered to the contained IoEventLoops, false otherwise.

Specified by:

isCompatible in interface IoEventLoopGroup

Parameters:

handleType - the type of the IoHandle.

Returns:

if compatible of not.

isIoType

boolean isIoType(Class<? extends IoHandler> handlerType)

Description copied from interface: IoEventLoopGroup

Returns true if the given IoHandler type is used by this IoEventLoopGroup, false otherwise.

Specified by:

isIoType in interface IoEventLoopGroup

Parameters:

handlerType - the type of the IoHandler.

Returns:

if used or not.