Module io.netty5.transport

Package io.netty5.channel

Class MultithreadEventLoopGroup

java.lang.Object

io.netty5.util.concurrent.MultithreadEventExecutorGroup

io.netty5.channel.MultithreadEventLoopGroup

All Implemented Interfaces:

EventLoopGroup, EventExecutorGroup, Iterable<EventExecutor>, Executor

public class MultithreadEventLoopGroup
extends MultithreadEventExecutorGroup
implements EventLoopGroup

EventLoopGroup implementation that will handle its tasks with multiple threads.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_EVENT_LOOP_THREADS

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultithreadEventLoopGroup(int nThreads, IoHandlerFactory ioHandlerFactory)	Create a new instance.
	MultithreadEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory)	Create a new instance.
	MultithreadEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler)	Create a new instance.
	MultithreadEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler, int maxTasksPerRun)	Create a new instance.
protected	MultithreadEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler, int maxTasksPerRun, Object... args)	Create a new instance.
	MultithreadEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Create a new instance.
	MultithreadEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler)	Create a new instance.
	MultithreadEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler, int maxTasksPerRun)	Create a new instance.
protected	MultithreadEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler, int maxTasksPerRun, Object... args)	Create a new instance.
	MultithreadEventLoopGroup(IoHandlerFactory ioHandlerFactory)	Create a new instance.
	MultithreadEventLoopGroup(Executor executor, IoHandlerFactory ioHandlerFactory)	Create a new instance.
	MultithreadEventLoopGroup(ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
protected EventLoop	newChild(Executor executor, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler, IoHandler ioHandler, int maxTasksPerRun, Object... args)	Creates a new EventLoop to use.
protected EventLoop	newChild(Executor executor, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler, Object... args)	Create a new EventExecutor which will later then accessible via the MultithreadEventExecutorGroup.next() method.
EventLoop	next()	Returns the next EventExecutor to use.
protected static int	pickThreadCount(int nThreads)	Return the number of threads to use based on the given nThreads.

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

awaitTermination, executorCount, executors, isShutdown, isShuttingDown, isTerminated, iterator, shutdownGracefully, terminationFuture

Methods inherited from class java.lang.Object

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

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

awaitTermination, execute, isShutdown, isShuttingDown, isTerminated, iterator, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdownGracefully, shutdownGracefully, submit, submit, submit, terminationFuture

Methods inherited from interface io.netty5.channel.EventLoopGroup

isCompatible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_EVENT_LOOP_THREADS

public static final int DEFAULT_EVENT_LOOP_THREADS

Constructor Detail

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters:

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(int nThreads,
                                 IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters:

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

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup

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

Create a new instance.

Parameters:

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

executor - the Executor to use, or null if the default should be used.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup

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

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.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(Executor executor,
                                 IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters:

executor - the Executor to use, or null if the default should be used.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(ThreadFactory threadFactory,
                                 IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters:

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

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(int nThreads,
                                 Executor executor,
                                 IoHandlerFactory ioHandlerFactory,
                                 int maxPendingTasks,
                                 RejectedExecutionHandler rejectedHandler)

Create a new instance.

Parameters:

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

executor - the Executor to use, or null if the default should be used.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(int nThreads,
                                 ThreadFactory threadFactory,
                                 IoHandlerFactory ioHandlerFactory,
                                 int maxPendingTasks,
                                 RejectedExecutionHandler rejectedHandler)

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.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(int nThreads,
                                 Executor executor,
                                 IoHandlerFactory ioHandlerFactory,
                                 int maxPendingTasks,
                                 RejectedExecutionHandler rejectedHandler,
                                 int maxTasksPerRun)

Create a new instance.

Parameters:

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

executor - the Executor to use, or null if the default should be used.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

maxTasksPerRun - the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

MultithreadEventLoopGroup

public MultithreadEventLoopGroup(int nThreads,
                                 ThreadFactory threadFactory,
                                 IoHandlerFactory ioHandlerFactory,
                                 int maxPendingTasks,
                                 RejectedExecutionHandler rejectedHandler,
                                 int maxTasksPerRun)

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.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

maxTasksPerRun - the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

MultithreadEventLoopGroup

protected MultithreadEventLoopGroup(int nThreads,
                                    Executor executor,
                                    IoHandlerFactory ioHandlerFactory,
                                    int maxPendingTasks,
                                    RejectedExecutionHandler rejectedHandler,
                                    int maxTasksPerRun,
                                    Object... args)

Create a new instance.

Parameters:

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

executor - the Executor to use, or null if the default should be used.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

maxTasksPerRun - the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

args - extra arguments passed to newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...)

MultithreadEventLoopGroup

protected MultithreadEventLoopGroup(int nThreads,
                                    ThreadFactory threadFactory,
                                    IoHandlerFactory ioHandlerFactory,
                                    int maxPendingTasks,
                                    RejectedExecutionHandler rejectedHandler,
                                    int maxTasksPerRun,
                                    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.

ioHandlerFactory - the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

maxPendingTasks - the maximum number of pending tasks before new tasks will be rejected.

rejectedHandler - the RejectedExecutionHandler to use.

maxTasksPerRun - the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

args - extra arguments passed to newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...)

Method Detail

pickThreadCount

protected static int pickThreadCount(int nThreads)

Return the number of threads to use based on the given nThreads.

next

public final EventLoop next()

Description copied from class: MultithreadEventExecutorGroup

Returns the next EventExecutor to use. The default implementation will use round-robin, but you may override this to change the selection algorithm.

Specified by:

next in interface EventExecutorGroup

Specified by:

next in interface EventLoopGroup

Overrides:

next in class MultithreadEventExecutorGroup

newChild

protected final EventLoop newChild(Executor executor,
                                   int maxPendingTasks,
                                   RejectedExecutionHandler rejectedExecutionHandler,
                                   Object... args)

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. As this method is called from within the constructor you can only use the parameters passed into the method when overriding this method.

Overrides:

newChild in class MultithreadEventExecutorGroup

newChild

protected EventLoop newChild(Executor executor,
                             int maxPendingTasks,
                             RejectedExecutionHandler rejectedExecutionHandler,
                             IoHandler ioHandler,
                             int maxTasksPerRun,
                             Object... args)

Creates a new EventLoop to use. As this method is called from within the constructor you can only use the parameters passed into the method when overriding this method.

Parameters:

executor - the Executor to use for execution.

maxPendingTasks - the maximum number of pending tasks.

rejectedExecutionHandler - the RejectedExecutionHandler to use when the number of outstanding tasks reach maxPendingTasks.

ioHandler - the IoHandler to use.

maxTasksPerRun - the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

args - any extra args needed to construct the EventLoop. This will be an empty array if not sub-classes and extra arguments are given.

Returns:

the EventLoop to use.