Interface EventExecutorGroup

All Superinterfaces:

Executor, ExecutorService, Iterable<EventExecutor>, ScheduledExecutorService

All Known Subinterfaces:

EventExecutor, EventLoop, EventLoopGroup, IoEventLoop, IoEventLoopGroup, OrderedEventExecutor

All Known Implementing Classes:

AbstractEventExecutor, AbstractEventExecutorGroup, AbstractEventLoop, AbstractEventLoopGroup, AbstractScheduledEventExecutor, DefaultEventExecutor, DefaultEventExecutorGroup, DefaultEventLoop, DefaultEventLoopGroup, EpollEventLoop, EpollEventLoopGroup, GlobalEventExecutor, ImmediateEventExecutor, KQueueEventLoopGroup, LocalEventLoopGroup, ManualIoEventLoop, MultithreadEventExecutorGroup, MultithreadEventLoopGroup, MultiThreadIoEventLoopGroup, NioEventLoop, NioEventLoopGroup, NonStickyEventExecutorGroup, OioEventLoopGroup, SingleThreadEventExecutor, SingleThreadEventLoop, SingleThreadIoEventLoop, ThreadPerChannelEventLoop, ThreadPerChannelEventLoopGroup, UnorderedThreadPoolEventExecutor

public interface EventExecutorGroup
extends ScheduledExecutorService, Iterable<EventExecutor>

The EventExecutorGroup is responsible for providing the EventExecutor's to use via its next() method. Besides this, it is also responsible for handling their life-cycle and allows shutting them down in a global fashion.

Method Summary

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. shutdownGracefully(long, long, TimeUnit) or shutdownGracefully() instead.
Future<?>	shutdownGracefully()	Shortcut method for 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. shutdownGracefully(long, long, TimeUnit) or 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

isShuttingDown

boolean isShuttingDown()

Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.

shutdownGracefully

Future<?> shutdownGracefully()

Shortcut method for shutdownGracefully(long, long, TimeUnit) with sensible default values.

Returns:

the terminationFuture()

shutdownGracefully

Future<?> shutdownGracefully(long quietPeriod,
 long timeout,
 TimeUnit unit)

Signals this executor that the caller wants the executor to be shut down. Once this method is called, isShuttingDown() starts to return true, and the executor prepares to shut itself down. Unlike shutdown(), graceful shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.

Parameters:

quietPeriod - the quiet period as described in the documentation

timeout - the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period

unit - the unit of quietPeriod and timeout

Returns:

the terminationFuture()

terminationFuture

Future<?> terminationFuture()

Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

shutdown

@Deprecated
void shutdown()

Deprecated.

shutdownGracefully(long, long, TimeUnit) or shutdownGracefully() instead.

Specified by:

shutdown in interface ExecutorService

shutdownNow

@Deprecated
List<Runnable> shutdownNow()

Deprecated.

shutdownGracefully(long, long, TimeUnit) or shutdownGracefully() instead.

Specified by:

shutdownNow in interface ExecutorService

next

EventExecutor next()

Returns one of the EventExecutors managed by this EventExecutorGroup.

iterator

Iterator<EventExecutor> iterator()

Specified by:

iterator in interface Iterable<EventExecutor>

submit

Future<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

submit

<T> Future<T> submit(Runnable task,
 T result)

Specified by:

submit in interface ExecutorService

submit

<T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

ticker

default Ticker ticker()

The ticker for this executor. Usually the schedule(Runnable, long, TimeUnit) methods will follow the system ticker (i.e. System.nanoTime()), but especially for testing it is sometimes useful to have more control over the ticker. In that case, this method will be overridden. Code that schedules tasks on this executor should use this ticker in order to stay consistent with the executor (e.g. not be surprised by scheduled tasks running "early").

Returns:

The ticker for this scheduler

schedule

ScheduledFuture<?> schedule(Runnable command,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

schedule

<V> ScheduledFuture<V> schedule(Callable<V> callable,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface ScheduledExecutorService

scheduleAtFixedRate

ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
 long initialDelay,
 long period,
 TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

scheduleWithFixedDelay

ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
 long initialDelay,
 long delay,
 TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService