Top Description Fields Constructors Methods

io.netty5.channel

public Class MultithreadEventLoopGroup

Class Inheritance

extends MultithreadEventExecutorGroup
implements EventLoopGroup

java.lang.Object
io.netty5.util.concurrent.MultithreadEventExecutorGroup
io.netty5.channel.MultithreadEventLoopGroup

All Implemented Interfaces

io.netty5.channel.EventLoopGroup, io.netty5.util.concurrent.EventExecutorGroup, java.util.concurrent.Executor, java.lang.Iterable

Imports

io.netty5.util.NettyRuntime, io.netty5.util.concurrent.DefaultThreadFactory, .MultithreadEventExecutorGroup, .RejectedExecutionHandler, .RejectedExecutionHandlers, .ThreadPerTaskExecutor, io.netty5.util.internal.EmptyArrays, .SystemPropertyUtil, io.netty5.util.internal.logging.InternalLogger, .InternalLoggerFactory, java.util.ArrayList, .Arrays, .Collections, .List, java.util.concurrent.Executor, .ThreadFactory

EventLoopGroup implementation that will handle its tasks with multiple threads.

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT_EVENT_LOOP_THREADS
private static final InternalLogger	logger

Constructor Summary

Access	Constructor and Description
public	MultithreadEventLoopGroup(IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory) Create a new instance.
public	MultithreadEventLoopGroup(int the number of threads that will be used by this instance. nThreads, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory) Create a new instance.
public	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory) Create a new instance.
public	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory) Create a new instance.
public	MultithreadEventLoopGroup(Executor the `Executor` to use, or `null` if the default should be used. executor, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory) Create a new instance.
public	MultithreadEventLoopGroup(ThreadFactory the `ThreadFactory` to use, or `null` if the default should be used. threadFactory, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory) Create a new instance.
public	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory, int the maximum number of pending tasks before new tasks will be rejected. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use. rejectedHandler) Create a new instance.
public	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory, int the maximum number of pending tasks before new tasks will be rejected. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use. rejectedHandler) Create a new instance.
public	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory, int the maximum number of pending tasks before new tasks will be rejected. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use. rejectedHandler, int the maximum number of tasks per `EventLoop` run that will be processed before trying to handle IO again. maxTasksPerRun) Create a new instance.
public	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory, int the maximum number of pending tasks before new tasks will be rejected. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use. rejectedHandler, int the maximum number of tasks per `EventLoop` run that will be processed before trying to handle IO again. maxTasksPerRun) Create a new instance.
protected	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory, int the maximum number of pending tasks before new tasks will be rejected. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use. rejectedHandler, int the maximum number of tasks per `EventLoop` run that will be processed before trying to handle IO again. maxTasksPerRun, Object... extra arguments passed to `newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...)` args) Create a new instance.
protected	MultithreadEventLoopGroup(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, IoHandlerFactory the `IoHandlerFactory` to use for creating new `IoHandler` instances that will handle the IO for the `EventLoop`. ioHandlerFactory, int the maximum number of pending tasks before new tasks will be rejected. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use. rejectedHandler, int the maximum number of tasks per `EventLoop` run that will be processed before trying to handle IO again. maxTasksPerRun, Object... extra arguments passed to `newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...)` args) Create a new instance.

Method Summary

Modifier and Type	Method and Description
private static Object[]	merge(IoHandlerFactory ioHandlerFactory, int maxTasksPerRun, Object... args)
protected final EventLoop	newChild(Executor executor, int maxPendingTasks, RejectedExecutionHandler rejectedExecutionHandler, Object... args) Overrides io.netty5.util.concurrent.MultithreadEventExecutorGroup.newChild. Create a new EventExecutor which will later then accessible via the `next()` method.
protected EventLoop	Returns: the `EventLoop` to use. newChild(Executor the `Executor` to use for execution. executor, int the maximum number of pending tasks. maxPendingTasks, RejectedExecutionHandler the `RejectedExecutionHandler` to use when the number of outstanding tasks reach `maxPendingTasks`. rejectedExecutionHandler, IoHandler the `IoHandler` to use. ioHandler, int the maximum number of tasks per `EventLoop` run that will be processed before trying to handle IO again. maxTasksPerRun, Object... any extra args needed to construct the `EventLoop`. This will be an empty array if not sub-classes and extra arguments are given. args) Creates a new `EventLoop` to use.
private static ThreadFactory	newDefaultThreadFactory()
public final EventLoop	next() Overrides io.netty5.util.concurrent.MultithreadEventExecutorGroup.next. Implements io.netty5.channel.EventLoopGroup.next, io.netty5.util.concurrent.EventExecutorGroup.next. Return the next `EventLoop` to use
protected static int	pickThreadCount(int nThreads) Return the number of threads to use based on the given `nThreads`.

Inherited from io.netty5.util.concurrent.MultithreadEventExecutorGroup:: awaitTermination executorCount executors isShutdown isShuttingDown isTerminated iterator shutdownGracefully terminationFuture

Field Detail

DEFAULT_EVENT_LOOP_THREADS	back to summary
public static final int DEFAULT_EVENT_LOOP_THREADS

logger	back to summary
private static final InternalLogger logger

Constructor Detail

MultithreadEventLoopGroup back to summary

public MultithreadEventLoopGroup(IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters

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

MultithreadEventLoopGroup back to summary

public MultithreadEventLoopGroup(int nThreads, IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters

nThreads:int: the number of threads that will be used by this instance.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup back to summary

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

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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup back to summary

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

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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup back to summary

public MultithreadEventLoopGroup(Executor executor, IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters

executor:Executor: the Executor to use, or null if the default should be used.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup back to summary

public MultithreadEventLoopGroup(ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory)

Create a new instance.

Parameters

threadFactory:ThreadFactory: the ThreadFactory to use, or null if the default should be used.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.

MultithreadEventLoopGroup back to summary

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

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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.
maxPendingTasks:int: the maximum number of pending tasks before new tasks will be rejected.
rejectedHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use.

MultithreadEventLoopGroup back to summary

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

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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.
maxPendingTasks:int: the maximum number of pending tasks before new tasks will be rejected.
rejectedHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use.

MultithreadEventLoopGroup back to summary

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

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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.
maxPendingTasks:int: the maximum number of pending tasks before new tasks will be rejected.
rejectedHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use.
maxTasksPerRun:int: the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

MultithreadEventLoopGroup back to summary

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

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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.
maxPendingTasks:int: the maximum number of pending tasks before new tasks will be rejected.
rejectedHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use.
maxTasksPerRun:int: the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.

MultithreadEventLoopGroup back to summary

protected MultithreadEventLoopGroup(int nThreads, Executor executor, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler, int maxTasksPerRun, 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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.
maxPendingTasks:int: the maximum number of pending tasks before new tasks will be rejected.
rejectedHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use.
maxTasksPerRun:int: the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.
args:Object[]: extra arguments passed to newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...)

MultithreadEventLoopGroup back to summary

protected MultithreadEventLoopGroup(int nThreads, ThreadFactory threadFactory, IoHandlerFactory ioHandlerFactory, int maxPendingTasks, RejectedExecutionHandler rejectedHandler, int maxTasksPerRun, 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.
ioHandlerFactory:IoHandlerFactory: the IoHandlerFactory to use for creating new IoHandler instances that will handle the IO for the EventLoop.
maxPendingTasks:int: the maximum number of pending tasks before new tasks will be rejected.
rejectedHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use.
maxTasksPerRun:int: the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.
args:Object[]: extra arguments passed to newChild(Executor, int, RejectedExecutionHandler, IoHandler, int, Object...)

Method Detail

merge	back to summary
private static Object[] merge(IoHandlerFactory ioHandlerFactory, int maxTasksPerRun, Object... args)

newChild back to summary

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

Overrides io.netty5.util.concurrent.MultithreadEventExecutorGroup.newChild.

Doc from io.netty5.util.concurrent.MultithreadEventExecutorGroup.newChild.

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

Annotations

@Override

newChild back to summary

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:Executor: the Executor to use for execution.
maxPendingTasks:int: the maximum number of pending tasks.
rejectedExecutionHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use when the number of outstanding tasks reach maxPendingTasks.
ioHandler:IoHandler: the IoHandler to use.
maxTasksPerRun:int: the maximum number of tasks per EventLoop run that will be processed before trying to handle IO again.
args:Object[]: any extra args needed to construct the EventLoop. This will be an empty array if not sub-classes and extra arguments are given.

Returns:EventLoop

the EventLoop to use.

newDefaultThreadFactory	back to summary
private static ThreadFactory newDefaultThreadFactory()

next back to summary

public final EventLoop next()

Overrides io.netty5.util.concurrent.MultithreadEventExecutorGroup.next.

Implements io.netty5.channel.EventLoopGroup.next, io.netty5.util.concurrent.EventExecutorGroup.next.

Doc from io.netty5.channel.EventLoopGroup.next.

Return the next EventLoop to use

Annotations

@Override

pickThreadCount	back to summary
protected static int pickThreadCount(int nThreads) Return the number of threads to use based on the given `nThreads`.