io.netty.util.concurrent

Interface EventExecutor

All Superinterfaces:

AutoCloseable, EventExecutorGroup, Executor, ExecutorService, ScheduledExecutorService

All Known Subinterfaces:

EventLoop, PausableEventExecutor, WrappedEventExecutor

All Known Implementing Classes:

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

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

Methods

Modifier and Type	Method and Description
<E extends EventExecutor> Set<E>	children() Returns an unmodifiable singleton set which contains itself.
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,
EventExecutor	unwrap() Returns an EventExecutor that is not a WrappedEventExecutor.

Methods inherited from interface io.netty.util.concurrent.EventExecutorGroup

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

Methods inherited from interface java.util.concurrent.ExecutorService

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

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

next

EventExecutor next()

Returns a reference to itself.

Specified by:

next in interface EventExecutorGroup

children

<E extends EventExecutor> Set<E> children()

Returns an unmodifiable singleton set which contains itself.

Specified by:

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

unwrap

EventExecutor unwrap()

Returns an EventExecutor that is not a WrappedEventExecutor.

• A WrappedEventExecutor implementing this method must return the underlying EventExecutor while making sure that it's not a WrappedEventExecutor (e.g. by multiple calls to unwrap()).
• An EventExecutor that is not a WrappedEventExecutor must return a reference to itself.
• This method must not return null.

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.