Netty 4.1.107.Final · io.netty.util.concurrent.MultithreadEventExecutorGroup

Modifier and Type	Field and Description
private final EventExecutor[]	children
private final EventExecutorChooserFactory.EventExecutorChooser	chooser
private final Set<EventExecutor>	readonlyChildren
private final AtomicInteger	terminatedChildren
private final Promise<?>	terminationFuture

Access	Constructor and Description
protected	MultithreadEventExecutorGroup(int the number of threads that will be used by this instance. nThreads, ThreadFactory the ThreadFactory to use, or `null` if the default should be used. threadFactory, Object... arguments which will passed to each `newChild(Executor, Object...)` call args) Create a new instance.
protected	MultithreadEventExecutorGroup(int the number of threads that will be used by this instance. nThreads, Executor the Executor to use, or `null` if the default should be used. executor, Object... arguments which will passed to each `newChild(Executor, Object...)` call args) Create a new instance.
protected	MultithreadEventExecutorGroup(int the number of threads that will be used by this instance. nThreads, Executor the Executor to use, or `null` if the default should be used. executor, EventExecutorChooserFactory the `EventExecutorChooserFactory` to use. chooserFactory, Object... arguments which will passed to each `newChild(Executor, Object...)` call args) Create a new instance.

Method Summary

Modifier and Type	Method and Description
public boolean	awaitTermination(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
public final int	executorCount() Return the number of `EventExecutor` this implementation uses.
public boolean	isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down.
public boolean	isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down.
public boolean	isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down.
public Iterator<EventExecutor>	iterator() Implements io.netty.util.concurrent.EventExecutorGroup.iterator. Returns an iterator over elements of type `T`.
protected abstract EventExecutor	newChild(Executor executor, Object... args) Create a new EventExecutor which will later then accessible via the `next()` method.
protected ThreadFactory	newDefaultThreadFactory()
public EventExecutor	next() Implements io.netty.util.concurrent.EventExecutorGroup.next. Returns one of the `EventExecutor`s managed by this `EventExecutorGroup`.
public void	shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutorGroup.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown. Deprecated Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public Future<?>	shutdownGracefully(long the quiet period as described in the documentation quietPeriod, long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period timeout, TimeUnit the unit of `quietPeriod` and `timeout` unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down.
public Future<?>	terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated.

Inherited from io.netty.util.concurrent.AbstractEventExecutorGroup:: execute invokeAll invokeAll invokeAny invokeAny schedule schedule scheduleAtFixedRate scheduleWithFixedDelay shutdownGracefully shutdownNow submit submit submit

Field Detail

children	back to summary
private final EventExecutor[] children

chooser	back to summary
private final EventExecutorChooserFactory.EventExecutorChooser chooser

readonlyChildren	back to summary
private final Set<EventExecutor> readonlyChildren

terminatedChildren	back to summary
private final AtomicInteger terminatedChildren

terminationFuture	back to summary
private final Promise<?> terminationFuture

Constructor Detail

MultithreadEventExecutorGroup back to summary

MultithreadEventExecutorGroup	back to summary
protected MultithreadEventExecutorGroup(int nThreads, ThreadFactory threadFactory, Object... args) Create a new instance. Parameters nThreads:int the number of threads that will be used by this instance. threadFactory:ThreadFactory the ThreadFactory to use, or `null` if the default should be used. args:Object[] arguments which will passed to each `newChild(Executor, Object...)` call

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

Create a new instance.

Parameters

nThreads:int: the number of threads that will be used by this instance.
threadFactory:ThreadFactory: the ThreadFactory to use, or null if the default should be used.
args:Object[]: arguments which will passed to each newChild(Executor, Object...) call

MultithreadEventExecutorGroup back to summary

MultithreadEventExecutorGroup	back to summary
protected MultithreadEventExecutorGroup(int nThreads, Executor executor, Object... args) Create a new instance. Parameters nThreads:int the number of threads that will be used by this instance. executor:Executor the Executor to use, or `null` if the default should be used. args:Object[] arguments which will passed to each `newChild(Executor, Object...)` call

protected MultithreadEventExecutorGroup(int nThreads, Executor executor, Object... args)

Create a new instance.

Parameters

nThreads:int: the number of threads that will be used by this instance.
executor:Executor: the Executor to use, or null if the default should be used.
args:Object[]: arguments which will passed to each newChild(Executor, Object...) call

MultithreadEventExecutorGroup back to summary

MultithreadEventExecutorGroup	back to summary
protected MultithreadEventExecutorGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, Object... args) Create a new instance. Parameters nThreads:int the number of threads that will be used by this instance. executor:Executor the Executor to use, or `null` if the default should be used. chooserFactory:EventExecutorChooserFactory the `EventExecutorChooserFactory` to use. args:Object[] arguments which will passed to each `newChild(Executor, Object...)` call

protected MultithreadEventExecutorGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, Object... args)

Create a new instance.

Parameters

nThreads:int: the number of threads that will be used by this instance.
executor:Executor: the Executor to use, or null if the default should be used.
chooserFactory:EventExecutorChooserFactory: the EventExecutorChooserFactory to use.
args:Object[]: arguments which will passed to each newChild(Executor, Object...) call

Method Detail

awaitTermination back to summary

awaitTermination	back to summary
public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException Implements java.util.concurrent.ExecutorService.awaitTermination. Doc from java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:boolean `true` if this executor terminated and `false` if the timeout elapsed before termination Annotations @Override Exceptions InterruptedException: if interrupted while waiting

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

Implements java.util.concurrent.ExecutorService.awaitTermination.

Doc from java.util.concurrent.ExecutorService.awaitTermination.

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:boolean

true if this executor terminated and false if the timeout elapsed before termination

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting

executorCount	back to summary
public final int executorCount() Return the number of `EventExecutor` this implementation uses. This number is the maps 1:1 to the threads it use.

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Doc from java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down. Returns:boolean `true` if this executor has been shut down Annotations @Override

public boolean isShutdown()

Implements java.util.concurrent.ExecutorService.isShutdown.

Doc from java.util.concurrent.ExecutorService.isShutdown.

Returns true if this executor has been shut down.

Returns:boolean

true if this executor has been shut down

Annotations

@Override

isShuttingDown back to summary

isShuttingDown	back to summary
public boolean isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down. Annotations @Override

public boolean isShuttingDown()

Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

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

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Doc from java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down. Note that `isTerminated` is never `true` unless either `shutdown` or `shutdownNow` was called first. Returns:boolean `true` if all tasks have completed following shut down Annotations @Override

public boolean isTerminated()

Implements java.util.concurrent.ExecutorService.isTerminated.

Doc from java.util.concurrent.ExecutorService.isTerminated.

Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns:boolean

true if all tasks have completed following shut down

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<EventExecutor> iterator() Implements io.netty.util.concurrent.EventExecutorGroup.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<EventExecutor> an Iterator. Annotations @Override

public Iterator<EventExecutor> iterator()

Implements io.netty.util.concurrent.EventExecutorGroup.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<EventExecutor>

an Iterator.

Annotations

@Override

newChild	back to summary
protected abstract EventExecutor newChild(Executor executor, 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`.

newDefaultThreadFactory	back to summary
protected ThreadFactory newDefaultThreadFactory()

next back to summary

next	back to summary
public EventExecutor next() Implements io.netty.util.concurrent.EventExecutorGroup.next. Doc from io.netty.util.concurrent.EventExecutorGroup.next. Returns one of the `EventExecutor`s managed by this `EventExecutorGroup`. Annotations @Override

public EventExecutor next()

Implements io.netty.util.concurrent.EventExecutorGroup.next.

Doc from io.netty.util.concurrent.EventExecutorGroup.next.

Returns one of the EventExecutors managed by this EventExecutorGroup.

Annotations

@Override

shutdown back to summary

shutdown	back to summary
public void shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutorGroup.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown. Doc from java.util.concurrent.ExecutorService.shutdown. Deprecated Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down. This method does not wait for previously submitted tasks to complete execution. Use `awaitTermination` to do that. Annotations @Override @Deprecated

public void shutdown()

Implements abstract io.netty.util.concurrent.AbstractEventExecutorGroup.shutdown.

Implements io.netty.util.concurrent.EventExecutorGroup.shutdown.

Doc from java.util.concurrent.ExecutorService.shutdown.

Deprecated

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Annotations

@Override
@Deprecated

shutdownGracefully back to summary

shutdownGracefully	back to summary
public Future<?> shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. 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:long the quiet period as described in the documentation timeout:long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period unit:TimeUnit the unit of `quietPeriod` and `timeout` Returns:Future<?> the `terminationFuture()` Annotations @Override

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

Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

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:long: the quiet period as described in the documentation
timeout:long: the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period
unit:TimeUnit: the unit of quietPeriod and timeout

Returns:Future<?>

the terminationFuture()

Annotations

@Override

terminationFuture back to summary

terminationFuture	back to summary
public Future<?> terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated. Annotations @Override

public Future<?> terminationFuture()

Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

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

Annotations

@Override

public abstract Class MultithreadEventExecutorGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail