Interface EventExecutor

All Superinterfaces:

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

All Known Subinterfaces:

EventLoop, OrderedEventExecutor

All Known Implementing Classes:

AbstractEventExecutor, AbstractEventLoop, AbstractScheduledEventExecutor, DefaultEventExecutor, DefaultEventLoop, EpollEventLoop, GlobalEventExecutor, ImmediateEventExecutor, NioEventLoop, SingleThreadEventExecutor, SingleThreadEventLoop, ThreadPerChannelEventLoop, UnorderedThreadPoolEventExecutor

public interface EventExecutor
extends EventExecutorGroup

The EventExecutor is a special EventExecutorGroup which comes with some handy methods to see if a Thread is executed in a event loop. Besides this, it also extends the EventExecutorGroup to allow for a generic way to access methods.

Method Summary

Modifier and Type	Method	Description
boolean	inEventLoop()	Calls 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.
EventExecutorGroup	parent()	Return the EventExecutorGroup which is the parent of this EventExecutor,

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 Executor

execute

Methods inherited from interface ExecutorService

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

Methods inherited from interface Iterable

forEach, spliterator

Method Details

next

EventExecutor next()

Returns a reference to itself.

Specified by:

next in interface EventExecutorGroup

parent

EventExecutorGroup parent()

Return the EventExecutorGroup which is the parent of this EventExecutor,

inEventLoop

boolean inEventLoop()

Calls inEventLoop(Thread) with Thread.currentThread() as argument

inEventLoop

boolean inEventLoop(Thread thread)

Return true if the given Thread is executed in the event loop, false otherwise.

newPromise

<V> Promise<V> newPromise()

Return a new Promise.

newProgressivePromise

<V> ProgressivePromise<V> newProgressivePromise()

Create a new ProgressivePromise.

newSucceededFuture

<V> Future<V> newSucceededFuture(V result)

Create a new Future which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

newFailedFuture

<V> Future<V> newFailedFuture(Throwable cause)

Create a new Future which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.