io.netty.channel.epoll

Class EpollEventLoop

java.lang.Object

java.util.concurrent.AbstractExecutorService

io.netty.util.concurrent.AbstractEventExecutor

io.netty.util.concurrent.AbstractScheduledEventExecutor

io.netty.util.concurrent.SingleThreadEventExecutor

io.netty.channel.SingleThreadEventLoop

io.netty.channel.epoll.EpollEventLoop

All Implemented Interfaces:

EventLoop, EventLoopGroup, EventExecutor, EventExecutorGroup, OrderedEventExecutor, java.lang.Iterable<EventExecutor>, java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent.ScheduledExecutorService

final class EpollEventLoop
extends SingleThreadEventLoop

EventLoop which uses epoll under the covers. Only works on Linux!

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowGrowing
private IntObjectMap<AbstractEpollChannel>	channels
private FileDescriptor	epollFd
private FileDescriptor	eventFd
private EpollEventArray	events
private int	ioRatio
private IovArray	iovArray
private static InternalLogger	logger
private java.util.concurrent.Callable<java.lang.Integer>	pendingTasksCallable
private IntSupplier	selectNowSupplier
private SelectStrategy	selectStrategy
private static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<EpollEventLoop>	WAKEN_UP_UPDATER
private int	wakenUp

Fields inherited from class io.netty.channel.SingleThreadEventLoop

DEFAULT_MAX_PENDING_TASKS

Constructor Summary

Constructors

Constructor and Description
EpollEventLoop(EventLoopGroup parent, java.util.concurrent.Executor executor, int maxEvents, SelectStrategy strategy, RejectedExecutionHandler rejectedExecutionHandler)

Method Summary

Modifier and Type	Method and Description
(package private) void	add(AbstractEpollChannel ch) Register the given epoll with this EventLoop.
(package private) IovArray	cleanArray() Return a cleared IovArray that can be used for writes in this EventLoop.
protected void	cleanup() Do nothing, sub-classes may override
private void	closeAll()
private int	epollWait(boolean oldWakenUp)
int	getIoRatio() Returns the percentage of the desired amount of time spent for I/O in the event loop.
private static void	handleLoopException(java.lang.Throwable t)
(package private) void	modify(AbstractEpollChannel ch) The flags of the given epoll was modified so update the registration
protected java.util.Queue<java.lang.Runnable>	newTaskQueue(int maxPendingTasks) Create a new Queue which will holds the tasks to execute.
int	pendingTasks() Return the number of tasks that are pending for processing.
private void	processReady(EpollEventArray events, int ready)
(package private) void	remove(AbstractEpollChannel ch) Deregister the given epoll from this EventLoop.
protected void	run()
void	setIoRatio(int ioRatio) Sets the percentage of the desired amount of time spent for I/O in the event loop.
protected void	wakeup(boolean inEventLoop)

Methods inherited from class io.netty.channel.SingleThreadEventLoop

afterRunningAllTasks, executeAfterEventLoopIteration, hasTasks, next, parent, register, register, register, wakesUpForTask

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

addShutdownHook, addTask, awaitTermination, confirmShutdown, delayNanos, execute, inEventLoop, interruptThread, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isShuttingDown, isTerminated, newTaskQueue, peekTask, pollTask, pollTaskFrom, reject, reject, removeShutdownHook, removeTask, runAllTasks, runAllTasks, runAllTasksFrom, shutdown, shutdownGracefully, takeTask, terminationFuture, threadProperties, updateLastExecutionTime

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

cancelScheduledTasks, hasScheduledTasks, nanoTime, nextScheduledTaskNano, pollScheduledTask, pollScheduledTask, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay

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

inEventLoop, iterator, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, newTaskFor, newTaskFor, safeExecute, 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.EventExecutor

inEventLoop, inEventLoop, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture

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

isShuttingDown, iterator, 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.Iterable

forEach, spliterator

Field Detail

logger

private static final InternalLogger logger

WAKEN_UP_UPDATER

private static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<EpollEventLoop> WAKEN_UP_UPDATER

epollFd

private final FileDescriptor epollFd

eventFd

private final FileDescriptor eventFd

channels

private final IntObjectMap<AbstractEpollChannel> channels

allowGrowing

private final boolean allowGrowing

events

private final EpollEventArray events

iovArray

private final IovArray iovArray

selectStrategy

private final SelectStrategy selectStrategy

selectNowSupplier

private final IntSupplier selectNowSupplier

pendingTasksCallable

private final java.util.concurrent.Callable<java.lang.Integer> pendingTasksCallable

wakenUp

private volatile int wakenUp

ioRatio

private volatile int ioRatio

Constructor Detail

EpollEventLoop

EpollEventLoop(EventLoopGroup parent,
               java.util.concurrent.Executor executor,
               int maxEvents,
               SelectStrategy strategy,
               RejectedExecutionHandler rejectedExecutionHandler)

Method Detail

cleanArray

IovArray cleanArray()

Return a cleared IovArray that can be used for writes in this EventLoop.

wakeup

protected void wakeup(boolean inEventLoop)

Overrides:

wakeup in class SingleThreadEventExecutor

add

void add(AbstractEpollChannel ch)
  throws java.io.IOException

Register the given epoll with this EventLoop.

Throws:

java.io.IOException

modify

void modify(AbstractEpollChannel ch)
     throws java.io.IOException

The flags of the given epoll was modified so update the registration

Throws:

java.io.IOException

remove

void remove(AbstractEpollChannel ch)
     throws java.io.IOException

Deregister the given epoll from this EventLoop.

Throws:

java.io.IOException

newTaskQueue

protected java.util.Queue<java.lang.Runnable> newTaskQueue(int maxPendingTasks)

Description copied from class: SingleThreadEventExecutor

Create a new Queue which will holds the tasks to execute. This default implementation will return a LinkedBlockingQueue but if your sub-class of SingleThreadEventExecutor will not do any blocking calls on the this Queue it may make sense to @Override this and return some more performant implementation that does not support blocking operations at all.

Overrides:

newTaskQueue in class SingleThreadEventExecutor

pendingTasks

public int pendingTasks()

Description copied from class: SingleThreadEventExecutor

Return the number of tasks that are pending for processing. Be aware that this operation may be expensive as it depends on the internal implementation of the SingleThreadEventExecutor. So use it was care!

Overrides:

pendingTasks in class SingleThreadEventLoop

getIoRatio

public int getIoRatio()

Returns the percentage of the desired amount of time spent for I/O in the event loop.

setIoRatio

public void setIoRatio(int ioRatio)

Sets the percentage of the desired amount of time spent for I/O in the event loop. 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.

epollWait

private int epollWait(boolean oldWakenUp)
               throws java.io.IOException

Throws:

java.io.IOException

run

protected void run()

Specified by:

run in class SingleThreadEventExecutor

handleLoopException

private static void handleLoopException(java.lang.Throwable t)

closeAll

private void closeAll()

processReady

private void processReady(EpollEventArray events,
                          int ready)

cleanup

protected void cleanup()

Description copied from class: SingleThreadEventExecutor

Do nothing, sub-classes may override

Overrides:

cleanup in class SingleThreadEventExecutor