Interface EventExecutor

All Superinterfaces:

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

All Known Subinterfaces:

EventLoop, IoEventLoop, OrderedEventExecutor

All Known Implementing Classes:

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

public interface EventExecutor
extends EventExecutorGroup, ThreadAwareExecutor

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
default 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.
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.
EventExecutorGroup	parent()	Return the EventExecutorGroup which is the parent of this EventExecutor,
default boolean	trySuspend()	Try to suspend this EventExecutor and return true if suspension was successful.

Methods inherited from interface EventExecutorGroup

isShuttingDown, iterator, next, 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()
EventExecutor	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.
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 Executor

execute

Methods inherited from interface ExecutorService

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

Methods inherited from interface Iterable

forEach, spliterator

Method Details

parent

EventExecutorGroup parent()

Return the EventExecutorGroup which is the parent of this EventExecutor,

isExecutorThread

default boolean isExecutorThread(Thread thread)

Description copied from interface: ThreadAwareExecutor

Return true if the given Thread is used by this ThreadAwareExecutor to execute work.

Specified by:

isExecutorThread in interface ThreadAwareExecutor

inEventLoop

default 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

default <V> Promise<V> newPromise()

Return a new Promise.

newProgressivePromise

default <V> ProgressivePromise<V> newProgressivePromise()

Create a new ProgressivePromise.

newSucceededFuture

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

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

isSuspended

default boolean isSuspended()

Returns true if the EventExecutor is considered suspended.

Returns:

true if suspended, false otherwise.

trySuspend

default boolean trySuspend()

Try to suspend this EventExecutor and return true if suspension was successful. Suspending an EventExecutor will allow it to free up resources, like for example a Thread that is backing the EventExecutor. Once an EventExecutor was suspended it will be started again by submitting work to it via one of the following methods:

• Executor.execute(Runnable)
• EventExecutorGroup.schedule(Runnable, long, TimeUnit)
• EventExecutorGroup.schedule(Callable, long, TimeUnit)
• EventExecutorGroup.scheduleAtFixedRate(Runnable, long, long, TimeUnit)
• EventExecutorGroup.scheduleWithFixedDelay(Runnable, long, long, TimeUnit)

Even if this method returns true it might take some time for the EventExecutor to fully suspend itself.

Returns:

true if suspension was successful, otherwise false.