io.netty.channel.epoll

Class EpollEventLoopGroup

java.lang.Object

io.netty.util.concurrent.AbstractEventExecutorGroup

io.netty.util.concurrent.MultithreadEventExecutorGroup

io.netty.channel.MultithreadEventLoopGroup

io.netty.channel.epoll.EpollEventLoopGroup

All Implemented Interfaces:

EventLoopGroup, EventExecutorGroup, AutoCloseable, Executor, ExecutorService, ScheduledExecutorService

public final class EpollEventLoopGroup
extends MultithreadEventLoopGroup

A MultithreadEventLoopGroup which uses epoll under the covers. This EventLoopGroup works only on Linux systems!

Constructor Summary

Constructors

Constructor and Description
EpollEventLoopGroup() Create a new instance that uses twice as many EventLoops as there processors/cores available, as well as the default Executor.
EpollEventLoopGroup(int nEventLoops) Create a new instance that uses the default Executor.
EpollEventLoopGroup(int nEventLoops, Executor executor)
EpollEventLoopGroup(int nEventLoops, Executor executor, int maxEventsAtOnce) Deprecated. Use EpollEventLoopGroup(int), EpollEventLoopGroup(int) or EpollEventLoopGroup(int, Executor)
EpollEventLoopGroup(int nEventLoops, ExecutorServiceFactory executorServiceFactory)
EpollEventLoopGroup(int nEventLoops, ExecutorServiceFactory executorServiceFactory, int maxEventsAtOnce) Deprecated. Use EpollEventLoopGroup(int), EpollEventLoopGroup(int) or EpollEventLoopGroup(int, ExecutorServiceFactory)

Method Summary

Methods

Modifier and Type	Method and Description
protected EventLoop	newChild(Executor executor, Object... args) Create a new EventExecutor which will later then accessible via the MultithreadEventExecutorGroup.next() method.
void	setIoRatio(int ioRatio) Sets the percentage of the desired amount of time spent for I/O in the child event loops.

Methods inherited from class io.netty.channel.MultithreadEventLoopGroup

next, register, register

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

awaitTermination, children, executorCount, isShutdown, isShuttingDown, isTerminated, newDefaultExecutorService, shutdown, shutdownGracefully, terminationFuture

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

close, 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

children, isShuttingDown, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdown, shutdownGracefully, shutdownGracefully, shutdownNow, submit, submit, submit, terminationFuture

Methods inherited from interface java.util.concurrent.ExecutorService

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

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

EpollEventLoopGroup

public EpollEventLoopGroup()

Create a new instance that uses twice as many EventLoops as there processors/cores available, as well as the default Executor.

See Also:

DefaultExecutorServiceFactory

EpollEventLoopGroup

public EpollEventLoopGroup(int nEventLoops)

Create a new instance that uses the default Executor.

Parameters:

nEventLoops - the number of EventLoops that will be used by this instance. If executor is null this number will also be the parallelism requested from the default executor. It is generally advised for the number of EventLoops and the number of Threads used by the

See Also:

DefaultExecutorServiceFactory

EpollEventLoopGroup

public EpollEventLoopGroup(int nEventLoops,
                   Executor executor)

Parameters:

nEventLoops - the number of EventLoops that will be used by this instance. If executor is null this number will also be the parallelism requested from the default executor. It is generally advised for the number of EventLoops and the number of Threads used by the executor to lie very close together.

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

EpollEventLoopGroup

public EpollEventLoopGroup(int nEventLoops,
                   ExecutorServiceFactory executorServiceFactory)

Parameters:

nEventLoops - the number of EventLoops that will be used by this instance. If executor is null this number will also be the parallelism requested from the default executor. It is generally advised for the number of EventLoops and the number of Threads used by the executor to lie very close together.

executorServiceFactory - the ExecutorServiceFactory to use, or null if the default should be used.

EpollEventLoopGroup

@Deprecated
public EpollEventLoopGroup(int nEventLoops,
                              Executor executor,
                              int maxEventsAtOnce)

Deprecated. Use EpollEventLoopGroup(int), EpollEventLoopGroup(int) or EpollEventLoopGroup(int, Executor)

Parameters:

nEventLoops - the number of EventLoops that will be used by this instance. If executor is null this number will also be the parallelism requested from the default executor. It is generally advised for the number of EventLoops and the number of Threads used by the executor to lie very close together.

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

maxEventsAtOnce - the maximum number of epoll events to handle per epollWait(...).

EpollEventLoopGroup

@Deprecated
public EpollEventLoopGroup(int nEventLoops,
                              ExecutorServiceFactory executorServiceFactory,
                              int maxEventsAtOnce)

Deprecated. Use EpollEventLoopGroup(int), EpollEventLoopGroup(int) or EpollEventLoopGroup(int, ExecutorServiceFactory)

Parameters:

nEventLoops - the number of EventLoops that will be used by this instance. If executor is null this number will also be the parallelism requested from the default executor. It is generally advised for the number of EventLoops and the number of Threads used by the executor to lie very close together.

executorServiceFactory - the ExecutorServiceFactory to use, or null if the default should be used.

maxEventsAtOnce - the maximum number of epoll events to handle per epollWait(...).

Method Detail

setIoRatio

public void setIoRatio(int ioRatio)

Sets the percentage of the desired amount of time spent for I/O in the child event loops. The default value is 50, which means the event loop will try to spend the same amount of time for I/O as for non-I/O tasks.

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