Package io.netty.channel

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, java.lang.Iterable<EventExecutor>, java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent.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, java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory, EventExecutorChooserFactory chooserFactory, java.lang.Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory, java.lang.Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
	MultiThreadIoEventLoopGroup(int nThreads, java.util.concurrent.Executor executor, EventExecutorChooserFactory chooserFactory, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup.
	MultiThreadIoEventLoopGroup(int nThreads, java.util.concurrent.ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, java.util.concurrent.ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, EventExecutorChooserFactory chooserFactory, java.lang.Object... args)	Creates a new instance of the MultiThreadIoEventLoopGroup.
protected	MultiThreadIoEventLoopGroup(int nThreads, java.util.concurrent.ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, java.lang.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(java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory)	Creates a new instance of the MultiThreadIoEventLoopGroup using the default number of threads.
	MultiThreadIoEventLoopGroup(java.util.concurrent.ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Create a new instance using the default number of thread.

Method Summary

Modifier and Type	Method	Description
protected IoEventLoop	newChild(java.util.concurrent.Executor executor, IoHandlerFactory ioHandlerFactory, java.lang.Object... args)	Creates a new IoEventLoop to use with the given Executor and IoHandler.
protected EventLoop	newChild(java.util.concurrent.Executor executor, java.lang.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 io.netty.channel.MultithreadEventLoopGroup

newDefaultThreadFactory, register, register, register

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

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

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

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

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

Methods inherited from interface io.netty.channel.EventLoopGroup

register

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

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

Methods inherited from interface io.netty.channel.IoEventLoopGroup

isCompatible, isIoType, register, register, register

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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(java.util.concurrent.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(java.util.concurrent.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,
                                   java.util.concurrent.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,
                                   java.util.concurrent.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,
                                   java.util.concurrent.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,
                                      java.util.concurrent.Executor executor,
                                      IoHandlerFactory ioHandlerFactory,
                                      java.lang.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,
                                      java.util.concurrent.ThreadFactory threadFactory,
                                      IoHandlerFactory ioHandlerFactory,
                                      java.lang.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,
                                      java.util.concurrent.ThreadFactory threadFactory,
                                      IoHandlerFactory ioHandlerFactory,
                                      EventExecutorChooserFactory chooserFactory,
                                      java.lang.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,
                                      java.util.concurrent.Executor executor,
                                      IoHandlerFactory ioHandlerFactory,
                                      EventExecutorChooserFactory chooserFactory,
                                      java.lang.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 Detail

newChild

protected EventLoop newChild(java.util.concurrent.Executor executor,
                             java.lang.Object... args)
                      throws java.lang.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:

java.lang.Exception

newChild

protected IoEventLoop newChild(java.util.concurrent.Executor executor,
                               IoHandlerFactory ioHandlerFactory,
                               java.lang.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