Interface IoEventLoopGroup

All Superinterfaces:

EventExecutorGroup, EventLoopGroup, Executor, ExecutorService, Iterable<EventExecutor>, ScheduledExecutorService

All Known Subinterfaces:

IoEventLoop

All Known Implementing Classes:

EpollEventLoop, EpollEventLoopGroup, KQueueEventLoopGroup, LocalEventLoopGroup, ManualIoEventLoop, MultiThreadIoEventLoopGroup, NioEventLoop, NioEventLoopGroup, SingleThreadIoEventLoop

public interface IoEventLoopGroup
extends EventLoopGroup

EventLoopGroup for IoEventLoops.

Method Summary

Modifier and Type	Method	Description
default 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.
default boolean	isIoType(Class<? extends IoHandler> handlerType)	Returns true if the given IoHandler type is used by this IoEventLoopGroup, false otherwise.
IoEventLoop	next()	Return the next EventLoop to use
default ChannelFuture	register(Channel channel)	Deprecated. Use register(IoHandle)
default ChannelFuture	register(ChannelPromise promise)	Deprecated. Use register(IoHandle)
default Future<IoRegistration>	register(IoHandle handle)	Register the IoHandle to the EventLoop for I/O processing.

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 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 Iterable

forEach, spliterator

Method Details

next

IoEventLoop next()

Description copied from interface: EventLoopGroup

Return the next EventLoop to use

Specified by:

next in interface EventExecutorGroup

Specified by:

next in interface EventLoopGroup

register

@Deprecated
default ChannelFuture register(Channel channel)

Deprecated.

Use register(IoHandle)

Description copied from interface: EventLoopGroup

Register a Channel with this EventLoop. The returned ChannelFuture will get notified once the registration was complete.

Specified by:

register in interface EventLoopGroup

register

@Deprecated
default ChannelFuture register(ChannelPromise promise)

Deprecated.

Use register(IoHandle)

Description copied from interface: EventLoopGroup

Register a Channel with this EventLoop using a ChannelFuture. The passed ChannelFuture will get notified once the registration was complete and also will get returned.

Specified by:

register in interface EventLoopGroup

register

default Future<IoRegistration> register(IoHandle handle)

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

Parameters:

handle - the IoHandle to register.

Returns:

the Future that is notified once the operations completes.

isCompatible

default 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.

Parameters:

handleType - the type of the IoHandle.

Returns:

if compatible of not.

isIoType

default boolean isIoType(Class<? extends IoHandler> handlerType)

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

Parameters:

handlerType - the type of the IoHandler.

Returns:

if used or not.