Interface EventLoop

All Superinterfaces:

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

All Known Implementing Classes:

AbstractEventLoop, DefaultEventLoop, EpollEventLoop, NioEventLoop, SingleThreadEventLoop, ThreadPerChannelEventLoop

public interface EventLoop
extends OrderedEventExecutor, EventLoopGroup

Will handle all the I/O operations for a Channel once registered. One EventLoop instance will usually handle more than one Channel but this may depend on implementation details and internals.

Method Summary

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

Methods inherited from interface EventExecutor

inEventLoop, inEventLoop, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, next

Modifier and Type	Method	Description
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.
<V> Future<V>	newFailedFuture(Throwable cause)	Create a new Future which is marked as failed already.
<V> ProgressivePromise<V>	newProgressivePromise()	Create a new ProgressivePromise.
<V> Promise<V>	newPromise()	Return a new Promise.
<V> Future<V>	newSucceededFuture(V result)	Create a new Future which is marked as succeeded already.
EventExecutor	next()	Returns a reference to itself.

Methods inherited from interface EventExecutorGroup

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

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.

Methods inherited from interface EventLoopGroup

next, register, register, register

Modifier and Type	Method	Description
EventLoop	next()	Return the next EventLoop to use
ChannelFuture	register(Channel channel)	Register a Channel with this EventLoop.
ChannelFuture	register(ChannelPromise promise)	Register a Channel with this EventLoop using a ChannelFuture.
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

parent

EventLoopGroup parent()

Description copied from interface: EventExecutor

Return the EventExecutorGroup which is the parent of this EventExecutor,

Specified by:

parent in interface EventExecutor