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, Iterable<EventExecutor>, Executor, ExecutorService, ScheduledExecutorService

public final class EpollEventLoopGroup
extends MultithreadEventLoopGroup

EventLoopGroup which uses epoll under the covers. Because of this it only works on linux.

Constructor Summary

Constructors

Constructor	Description
EpollEventLoopGroup()	Create a new instance using the default number of threads and the default ThreadFactory.
EpollEventLoopGroup(int nThreads)	Create a new instance using the specified number of threads and the default ThreadFactory.
EpollEventLoopGroup(int nThreads, SelectStrategyFactory selectStrategyFactory)	Create a new instance using the specified number of threads and the default ThreadFactory.
EpollEventLoopGroup(int nThreads, Executor executor)
EpollEventLoopGroup(int nThreads, Executor executor, SelectStrategyFactory selectStrategyFactory)
EpollEventLoopGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, SelectStrategyFactory selectStrategyFactory)
EpollEventLoopGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, SelectStrategyFactory selectStrategyFactory, RejectedExecutionHandler rejectedExecutionHandler)
EpollEventLoopGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, SelectStrategyFactory selectStrategyFactory, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory queueFactory)
EpollEventLoopGroup(int nThreads, Executor executor, EventExecutorChooserFactory chooserFactory, SelectStrategyFactory selectStrategyFactory, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory taskQueueFactory, EventLoopTaskQueueFactory tailTaskQueueFactory)
EpollEventLoopGroup(int nThreads, ThreadFactory threadFactory)	Create a new instance using the specified number of threads and the given ThreadFactory.
EpollEventLoopGroup(int nThreads, ThreadFactory threadFactory, int maxEventsAtOnce)	Deprecated. Use EpollEventLoopGroup(int) or EpollEventLoopGroup(int, ThreadFactory)
EpollEventLoopGroup(int nThreads, ThreadFactory threadFactory, int maxEventsAtOnce, SelectStrategyFactory selectStrategyFactory)	Deprecated. Use EpollEventLoopGroup(int), EpollEventLoopGroup(int, ThreadFactory), or EpollEventLoopGroup(int, SelectStrategyFactory)
EpollEventLoopGroup(int nThreads, ThreadFactory threadFactory, SelectStrategyFactory selectStrategyFactory)	Create a new instance using the specified number of threads and the given ThreadFactory.
EpollEventLoopGroup(ThreadFactory threadFactory)	Create a new instance using the default number of threads and the given ThreadFactory.

Method Summary

Modifier and Type	Method	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 MultithreadEventLoopGroup

newDefaultThreadFactory, next, register, register, register

Modifier and Type	Method	Description
protected ThreadFactory	newDefaultThreadFactory()
EventLoop	next()	Returns one of the EventExecutors managed by this EventExecutorGroup.
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

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

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)
final int	executorCount()	Return the number of EventExecutor this implementation uses.
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 Iterable

forEach, spliterator

Constructor Details

EpollEventLoopGroup

public EpollEventLoopGroup()

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

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads)

Create a new instance using the specified number of threads and the default ThreadFactory.

EpollEventLoopGroup

public EpollEventLoopGroup(ThreadFactory threadFactory)

Create a new instance using the default number of threads and the given ThreadFactory.

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 SelectStrategyFactory selectStrategyFactory)

Create a new instance using the specified number of threads and the default ThreadFactory.

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 ThreadFactory threadFactory)

Create a new instance using the specified number of threads and the given ThreadFactory.

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 Executor executor)

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 ThreadFactory threadFactory,
 SelectStrategyFactory selectStrategyFactory)

Create a new instance using the specified number of threads and the given ThreadFactory.

EpollEventLoopGroup

@Deprecated
public EpollEventLoopGroup(int nThreads,
 ThreadFactory threadFactory,
 int maxEventsAtOnce)

Deprecated.

Use EpollEventLoopGroup(int) or EpollEventLoopGroup(int, ThreadFactory)

Create a new instance using the specified number of threads, the given ThreadFactory and the given maximal amount of epoll events to handle per epollWait(...).

EpollEventLoopGroup

@Deprecated
public EpollEventLoopGroup(int nThreads,
 ThreadFactory threadFactory,
 int maxEventsAtOnce,
 SelectStrategyFactory selectStrategyFactory)

Deprecated.

Use EpollEventLoopGroup(int), EpollEventLoopGroup(int, ThreadFactory), or EpollEventLoopGroup(int, SelectStrategyFactory)

Create a new instance using the specified number of threads, the given ThreadFactory and the given maximal amount of epoll events to handle per epollWait(...).

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 Executor executor,
 SelectStrategyFactory selectStrategyFactory)

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 Executor executor,
 EventExecutorChooserFactory chooserFactory,
 SelectStrategyFactory selectStrategyFactory)

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 Executor executor,
 EventExecutorChooserFactory chooserFactory,
 SelectStrategyFactory selectStrategyFactory,
 RejectedExecutionHandler rejectedExecutionHandler)

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 Executor executor,
 EventExecutorChooserFactory chooserFactory,
 SelectStrategyFactory selectStrategyFactory,
 RejectedExecutionHandler rejectedExecutionHandler,
 EventLoopTaskQueueFactory queueFactory)

EpollEventLoopGroup

public EpollEventLoopGroup(int nThreads,
 Executor executor,
 EventExecutorChooserFactory chooserFactory,
 SelectStrategyFactory selectStrategyFactory,
 RejectedExecutionHandler rejectedExecutionHandler,
 EventLoopTaskQueueFactory taskQueueFactory,
 EventLoopTaskQueueFactory tailTaskQueueFactory)

Parameters:

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

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

chooserFactory - the EventExecutorChooserFactory to use.

selectStrategyFactory - the SelectStrategyFactory to use.

rejectedExecutionHandler - the RejectedExecutionHandler to use.

taskQueueFactory - the EventLoopTaskQueueFactory to use for SingleThreadEventExecutor.execute(Runnable), or null if default one should be used.

tailTaskQueueFactory - the EventLoopTaskQueueFactory to use for SingleThreadEventLoop.executeAfterEventLoopIteration(Runnable), or null if default one should be used.

Method Details

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