Class MultiThreadIoEventLoopGroup

java.lang.Object

io.netty.util.concurrent.AbstractEventExecutorGroup

io.netty.util.concurrent.MultithreadEventExecutorGroup

io.netty.channel.MultithreadEventLoopGroup

io.netty.channel.MultiThreadIoEventLoopGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

EpollEventLoopGroup, KQueueEventLoopGroup, LocalEventLoopGroup, NioEventLoopGroup

public class MultiThreadIoEventLoopGroup
extends MultithreadEventLoopGroup
implements IoEventLoopGroup

IoEventLoopGroup implementation that will handle its tasks with multiple threads.

This group supports advanced thread management strategies, such as dynamic auto-scaling, by providing a custom EventExecutorChooserFactory. To enable utilization-based auto-scaling, pass an instance of AutoScalingEventExecutorChooserFactory.

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiThreadIoEventLoopGroup(int nThreads, IoHandlerFactory ioHandlerFactory)	/** Creates a new instance of the MultiThreadIoEventLoopGroup using the default ThreadFactory.
	MultiThreadIoEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory, EventExecutorChooserFactory chooserFactory, Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory, Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
	MultiThreadIoEventLoopGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup.
	MultiThreadIoEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, EventExecutorChooserFactory chooserFactory, Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
	MultiThreadIoEventLoopGroup(IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup using the default number of threads and default ThreadFactory.
	MultiThreadIoEventLoopGroup(Executor executor, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup using the default number of threads.
	MultiThreadIoEventLoopGroup(ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Create a new instance using the default number of thread.

Method Summary

Modifier and Type	Method	Description
protected IoEventLoop	newChild(Executor executor, IoHandlerFactory ioHandlerFactory, Object... args)	Creates a new IoEventLoop to use with the given Executor and IoHandler.
protected EventLoop	newChild(Executor executor, Object... args)	Create a new EventExecutor which will later then accessible via the MultithreadEventExecutorGroup.next() method.
IoEventLoop	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.

Methods inherited from class MultithreadEventLoopGroup

newDefaultThreadFactory, register, register, register

Modifier and Type	Method	Description
protected ThreadFactory	newDefaultThreadFactory()
ChannelFuture	register(Channel channel)	Register a Channel with this EventLoop.
ChannelFuture	register(ChannelPromise promise)	Register a Channel with this EventLoop using a ChannelFuture.
ChannelFuture	register(Channel channel, ChannelPromise promise)	Deprecated.

Methods inherited from class MultithreadEventExecutorGroup

activeExecutorCount, awaitTermination, executorCount, executorUtilizations, isShutdown, isShuttingDown, isTerminated, iterator, shutdown, shutdownGracefully, terminationFuture

Modifier and Type	Method	Description
int	activeExecutorCount()	Returns the number of currently active threads if the group is using an EventExecutorChooserFactory.ObservableEventExecutorChooser.
boolean	awaitTermination(long timeout, TimeUnit unit)
final int	executorCount()	Return the number of EventExecutor this implementation uses.
List<AutoScalingEventExecutorChooserFactory.AutoScalingUtilizationMetric>	executorUtilizations()	Returns a list of real-time utilization metrics if the group was configured with a compatible EventExecutorChooserFactory, otherwise an empty list.
boolean	isShutdown()
boolean	isShuttingDown()	Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.
boolean	isTerminated()
Iterator<EventExecutor>	iterator()
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 all EventExecutors managed by this EventExecutorGroup have been terminated.

Methods inherited from class AbstractEventExecutorGroup

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

Modifier and Type	Method	Description
void	execute(Runnable command)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
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)
Future<?>	shutdownGracefully()	Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.
List<Runnable>	shutdownNow()	Deprecated. EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) or AbstractEventExecutorGroup.shutdownGracefully() instead.
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)

Methods inherited from class Object

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

Methods inherited from interface EventExecutorGroup

ticker

Modifier and Type	Method	Description
default Ticker	ticker()	The ticker for this executor.

Methods inherited from interface IoEventLoopGroup

isCompatible, isIoType, register, register, register

Modifier and Type	Method	Description
default boolean	isCompatible(Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoEventLoopGroup and so can be registered to the contained IoEventLoops, false otherwise.
default boolean	isIoType(Class<? extends IoHandler> handlerType)	Returns true if the given IoHandler type is used by this IoEventLoopGroup, false otherwise.
default ChannelFuture	register(Channel channel)	Deprecated. Use IoEventLoopGroup.register(IoHandle)
default ChannelFuture	register(ChannelPromise promise)	Deprecated. Use IoEventLoopGroup.register(IoHandle)
default Future<IoRegistration>	register(IoHandle handle)	Register the IoHandle to the EventLoop for I/O processing.

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(IoHandlerFactory ioHandlerFactory)

Creates a new instance of the MultiThreadIoEventLoopGroup using the default number of threads and default ThreadFactory.

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(int nThreads,
 IoHandlerFactory ioHandlerFactory)

/** Creates a new instance of the MultiThreadIoEventLoopGroup using the default ThreadFactory.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(ThreadFactory threadFactory,
 IoHandlerFactory ioHandlerFactory)

Create a new instance using the default number of thread.

Parameters:

threadFactory - the ThreadFactory that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(Executor executor,
 IoHandlerFactory ioHandlerFactory)

Creates a new instance of the MultiThreadIoEventLoopGroup using the default number of threads.

Parameters:

executor - the Executor that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(int nThreads,
 Executor executor,
 IoHandlerFactory ioHandlerFactory)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

executor - the Executor that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(int nThreads,
 ThreadFactory threadFactory,
 IoHandlerFactory ioHandlerFactory)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

threadFactory - the ThreadFactory that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

MultiThreadIoEventLoopGroup

public MultiThreadIoEventLoopGroup(int nThreads,
 Executor executor,
 EventExecutorChooserFactory chooserFactory,
 IoHandlerFactory ioHandlerFactory)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

executor - the Executor that is used.

chooserFactory - the EventExecutorChooserFactory that is used to choose the IoEventLoop when next() is called.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

MultiThreadIoEventLoopGroup

protected MultiThreadIoEventLoopGroup(int nThreads,
 Executor executor,
 IoHandlerFactory ioHandlerFactory,
 Object... args)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

executor - the Executor that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

args - extra args that are passed to newChild(Executor, Object...) method.

MultiThreadIoEventLoopGroup

protected MultiThreadIoEventLoopGroup(int nThreads,
 ThreadFactory threadFactory,
 IoHandlerFactory ioHandlerFactory,
 Object... args)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

threadFactory - the ThreadFactory that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

args - extra args that are passed to newChild(Executor, Object...) method.

MultiThreadIoEventLoopGroup

protected MultiThreadIoEventLoopGroup(int nThreads,
 ThreadFactory threadFactory,
 IoHandlerFactory ioHandlerFactory,
 EventExecutorChooserFactory chooserFactory,
 Object... args)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

threadFactory - the ThreadFactory that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

chooserFactory - the EventExecutorChooserFactory that is used to choose the

args - extra args that are passed to newChild(Executor, Object...) method.

MultiThreadIoEventLoopGroup

protected MultiThreadIoEventLoopGroup(int nThreads,
 Executor executor,
 IoHandlerFactory ioHandlerFactory,
 EventExecutorChooserFactory chooserFactory,
 Object... args)

Creates a new instance of the MultiThreadIoEventLoopGroup.

Parameters:

nThreads - the number of threads and so EventLoops that are created.

executor - the Executor that is used.

ioHandlerFactory - the IoHandlerFactory that will be used to create IoHandler for handling IO.

chooserFactory - the EventExecutorChooserFactory that is used to choose the

args - extra args that are passed to newChild(Executor, Object...) method.

Method Details

newChild

protected EventLoop newChild(Executor executor,
 Object... args)
                      throws Exception

Description copied from class: MultithreadEventExecutorGroup

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

Specified by:

newChild in class MultithreadEventLoopGroup

Throws:

Exception

newChild

protected IoEventLoop newChild(Executor executor,
 IoHandlerFactory ioHandlerFactory,
 Object... args)

Creates a new IoEventLoop to use with the given Executor and IoHandler.

Parameters:

executor - the Executor that should be used to handle execution of tasks and IO.

ioHandlerFactory - the IoHandlerFactory that should be used to obtain IoHandler to handle IO.

args - extra arguments that are based by the constructor.

Returns:

the created IoEventLoop.

next

public IoEventLoop next()

Description copied from interface: EventExecutorGroup

Returns one of the EventExecutors managed by this EventExecutorGroup.

Specified by:

next in interface EventExecutorGroup

Specified by:

next in interface EventLoopGroup

Specified by:

next in interface IoEventLoopGroup

Overrides:

next in class MultithreadEventLoopGroup