io.netty.util.concurrent

Class MultithreadEventExecutorGroup

java.lang.Object

io.netty.util.concurrent.AbstractEventExecutorGroup

io.netty.util.concurrent.MultithreadEventExecutorGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultEventExecutorGroup, MultithreadEventLoopGroup

public abstract class MultithreadEventExecutorGroup
extends AbstractEventExecutorGroup

Abstract base class for EventExecutorGroup implementations that handles their tasks with multiple threads at the same time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultithreadEventExecutorGroup(int nThreads, ThreadFactory threadFactory, Object... args) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, TimeUnit unit)
protected Set<EventExecutor>	children() Return a safe-copy of all of the children of this group.
int	executorCount() Return the number of EventExecutor this implementation uses.
boolean	isShutdown()
boolean	isShuttingDown() Returns true if and only if this executor was started to be shut down gracefuclly or was shut down.
boolean	isTerminated()
Iterator<EventExecutor>	iterator() Returns a read-only Iterator over all EventExecutor, which are handled by this EventExecutorGroup at the time of invoke this method.
protected abstract EventExecutor	newChild(ThreadFactory threadFactory, Object... args) Create a new EventExecutor which will later then accessible via the next() method.
protected ThreadFactory	newDefaultThreadFactory()
EventExecutor	next() Returns one of the EventExecutors that belong to this group.
void	shutdown() Deprecated.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Signals this executor that the caller wants the executor to be shut down.
Future<?>	terminationFuture() Returns the Future which is notified when this executor has been terminated.

Methods inherited from class io.netty.util.concurrent.AbstractEventExecutorGroup

execute, invokeAll, invokeAll, invokeAny, invokeAny, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdownGracefully, shutdownNow, submit, submit, submit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultithreadEventExecutorGroup

protected MultithreadEventExecutorGroup(int nThreads,
                             ThreadFactory threadFactory,
                             Object... args)

Create a new instance.

Parameters:

nThreads - the number of threads that will be used by this instance.

threadFactory - the ThreadFactory to use, or null if the default should be used.

args - arguments which will passed to each newChild(ThreadFactory, Object...) call

Method Detail

newDefaultThreadFactory

protected ThreadFactory newDefaultThreadFactory()

next

public EventExecutor next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors that belong to this group.

iterator

public Iterator<EventExecutor> iterator()

Description copied from interface: EventExecutorGroup

Returns a read-only Iterator over all EventExecutor, which are handled by this EventExecutorGroup at the time of invoke this method.

executorCount

public final int executorCount()

Return the number of EventExecutor this implementation uses. This number is the maps 1:1 to the threads it use.

children

protected Set<EventExecutor> children()

Return a safe-copy of all of the children of this group.

newChild

protected abstract EventExecutor newChild(ThreadFactory threadFactory,
                     Object... args)
                                   throws Exception

Create a new EventExecutor which will later then accessible via the next() method. This method will be called for each thread that will serve this MultithreadEventExecutorGroup.

Throws:

Exception

shutdownGracefully

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

Description copied from interface: EventExecutorGroup

Signals this executor that the caller wants the executor to be shut down. Once this method is called, EventExecutorGroup.isShuttingDown() starts to return true, and the executor prepares to shut itself down. Unlike EventExecutorGroup.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 EventExecutorGroup.shutdown() regardless if a task was submitted during the quiet period

unit - the unit of quietPeriod and timeout

Returns:

the EventExecutorGroup.terminationFuture()

terminationFuture

public Future<?> terminationFuture()

Description copied from interface: EventExecutorGroup

Returns the Future which is notified when this executor has been terminated.

shutdown

@Deprecated
public void shutdown()

Deprecated.

Specified by:

shutdown in interface EventExecutorGroup

Specified by:

shutdown in interface ExecutorService

Specified by:

shutdown in class AbstractEventExecutorGroup

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: EventExecutorGroup

Returns true if and only if this executor was started to be shut down gracefuclly or was shut down.

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

awaitTermination

public boolean awaitTermination(long timeout,
                       TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException