Netty 4.1.107.Final · io.netty.channel.epoll.EpollEventLoop

Modifier and Type	Field and Description
private final boolean	allowGrowing
private static final long	AWAKE
private final IntObjectMap<AbstractEpollChannel>	channels
private NativeDatagramPacketArray	datagramPacketArray
private static final long	EPOLL_WAIT_MILLIS_THRESHOLD
private FileDescriptor	epollFd
private FileDescriptor	eventFd
private final EpollEventArray	events
private volatile int	ioRatio
private IovArray	iovArray
private static final InternalLogger	logger Hides io.netty.util.concurrent.SingleThreadEventExecutor.logger.
private static final long	MAX_SCHEDULED_TIMERFD_NS
private final AtomicLong	nextWakeupNanos
private static final long	NONE
private boolean	pendingWakeup
private final IntSupplier	selectNowSupplier
private final SelectStrategy	selectStrategy
private FileDescriptor	timerFd

Access	Constructor and Description
pack-priv	EpollEventLoop(EventLoopGroup parent, Executor executor, int maxEvents, SelectStrategy strategy, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory taskQueueFactory, EventLoopTaskQueueFactory tailTaskQueueFactory)

Method Summary

Modifier and Type	Method and Description
pack-priv void	add(AbstractEpollChannel ch) Register the given epoll with this `EventLoop`.
protected boolean	afterScheduledTaskSubmitted(long relative to `AbstractScheduledEventExecutor#getCurrentTimeNanos()` deadlineNanos) Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.afterScheduledTaskSubmitted. See `beforeScheduledTaskSubmitted(long)`.
protected boolean	beforeScheduledTaskSubmitted(long deadline of the to-be-scheduled task relative to `AbstractScheduledEventExecutor#getCurrentTimeNanos()` deadlineNanos) Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.beforeScheduledTaskSubmitted. Called from arbitrary non-`EventExecutor` threads prior to scheduled task submission.
pack-priv NativeDatagramPacketArray	cleanDatagramPacketArray() Return a cleared `NativeDatagramPacketArray` that can be used for writes in this `EventLoop`.
pack-priv IovArray	cleanIovArray() Return a cleared `IovArray` that can be used for writes in this `EventLoop`.
protected void	cleanup() Overrides io.netty.util.concurrent.SingleThreadEventExecutor.cleanup. Do nothing, sub-classes may override
private void	closeAll()
public void	closeFileDescriptors() This method is intended for use by process checkpoint/restore integration, such as OpenJDK CRaC.
private int	epollBusyWait()
private long	epollWait(long deadlineNanos)
private int	epollWaitNoTimerChange()
private int	epollWaitNow()
private int	epollWaitTimeboxed()
public int	getIoRatio() Returns the percentage of the desired amount of time spent for I/O in the event loop.
pack-priv void	handleLoopException(Throwable t) Visible only for testing!
pack-priv void	modify(AbstractEpollChannel ch) The flags of the given epoll was modified so update the registration
private static Queue<Runnable>	newTaskQueue(EventLoopTaskQueueFactory queueFactory)
protected Queue<Runnable>	newTaskQueue(int maxPendingTasks) Overrides io.netty.util.concurrent.SingleThreadEventExecutor.newTaskQueue. Create a new `Queue` which will holds the tasks to execute.
private static Queue<Runnable>	newTaskQueue0(int maxPendingTasks)
public void	openFileDescriptors() This method is intended for use by a process checkpoint/restore integration, such as OpenJDK CRaC.
private boolean	processReady(EpollEventArray events, int ready)
public int	registeredChannels() Overrides io.netty.channel.SingleThreadEventLoop.registeredChannels. Returns the number of `Channel`s registered with this `EventLoop` or `-1` if operation is not supported.
public Iterator<Channel>	registeredChannelsIterator() Overrides io.netty.channel.SingleThreadEventLoop.registeredChannelsIterator.
pack-priv void	remove(AbstractEpollChannel ch) Deregister the given epoll from this `EventLoop`.
protected void	run() Implements abstract io.netty.util.concurrent.SingleThreadEventExecutor.run. Run the tasks in the `taskQueue`
public 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) Overrides io.netty.util.concurrent.SingleThreadEventExecutor.wakeup.

Inherited from io.netty.channel.SingleThreadEventLoop:: afterRunningAllTasks executeAfterEventLoopIteration hasTasks next parent pendingTasks register register register

allowGrowing	back to summary
private final boolean allowGrowing

AWAKE	back to summary
private static final long AWAKE

channels	back to summary
private final IntObjectMap<AbstractEpollChannel> channels

datagramPacketArray	back to summary
private NativeDatagramPacketArray datagramPacketArray

EPOLL_WAIT_MILLIS_THRESHOLD	back to summary
private static final long EPOLL_WAIT_MILLIS_THRESHOLD

epollFd	back to summary
private FileDescriptor epollFd

eventFd	back to summary
private FileDescriptor eventFd

events	back to summary
private final EpollEventArray events

ioRatio	back to summary
private volatile int ioRatio

iovArray	back to summary
private IovArray iovArray

logger	back to summary
private static final InternalLogger logger Hides io.netty.util.concurrent.SingleThreadEventExecutor.logger.

MAX_SCHEDULED_TIMERFD_NS	back to summary
private static final long MAX_SCHEDULED_TIMERFD_NS

nextWakeupNanos	back to summary
private final AtomicLong nextWakeupNanos

NONE	back to summary
private static final long NONE

pendingWakeup	back to summary
private boolean pendingWakeup

selectNowSupplier	back to summary
private final IntSupplier selectNowSupplier

selectStrategy	back to summary
private final SelectStrategy selectStrategy

timerFd	back to summary
private FileDescriptor timerFd

EpollEventLoop	back to summary
pack-priv EpollEventLoop(EventLoopGroup parent, Executor executor, int maxEvents, SelectStrategy strategy, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory taskQueueFactory, EventLoopTaskQueueFactory tailTaskQueueFactory)

Method Detail

add	back to summary
pack-priv void add(AbstractEpollChannel ch) throws IOException Register the given epoll with this `EventLoop`.

afterScheduledTaskSubmitted back to summary

afterScheduledTaskSubmitted	back to summary
protected boolean afterScheduledTaskSubmitted(long deadlineNanos) Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.afterScheduledTaskSubmitted. Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.afterScheduledTaskSubmitted. See `beforeScheduledTaskSubmitted(long)`. Called only after that method returns false. Parameters deadlineNanos:long relative to `AbstractScheduledEventExecutor#getCurrentTimeNanos()` Returns:boolean `true` if the `EventExecutor` thread should be woken, `false` otherwise Annotations @Override

protected boolean afterScheduledTaskSubmitted(long deadlineNanos)

Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.afterScheduledTaskSubmitted.

Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.afterScheduledTaskSubmitted.

See beforeScheduledTaskSubmitted(long). Called only after that method returns false.

Parameters

deadlineNanos:long: relative to AbstractScheduledEventExecutor#getCurrentTimeNanos()

Returns:boolean

true if the EventExecutor thread should be woken, false otherwise

Annotations

@Override

beforeScheduledTaskSubmitted back to summary

beforeScheduledTaskSubmitted	back to summary
protected boolean beforeScheduledTaskSubmitted(long deadlineNanos) Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.beforeScheduledTaskSubmitted. Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.beforeScheduledTaskSubmitted. Called from arbitrary non-`EventExecutor` threads prior to scheduled task submission. Returns `true` if the `EventExecutor` thread should be woken immediately to process the scheduled task (if not already awake). If `false` is returned, `afterScheduledTaskSubmitted(long)` will be called with the same value after the scheduled task is enqueued, providing another opportunity to wake the `EventExecutor` thread if required. Parameters deadlineNanos:long deadline of the to-be-scheduled task relative to `AbstractScheduledEventExecutor#getCurrentTimeNanos()` Returns:boolean `true` if the `EventExecutor` thread should be woken, `false` otherwise Annotations @Override

protected boolean beforeScheduledTaskSubmitted(long deadlineNanos)

Overrides io.netty.util.concurrent.AbstractScheduledEventExecutor.beforeScheduledTaskSubmitted.

Doc from io.netty.util.concurrent.AbstractScheduledEventExecutor.beforeScheduledTaskSubmitted.

Called from arbitrary non-EventExecutor threads prior to scheduled task submission. Returns true if the EventExecutor thread should be woken immediately to process the scheduled task (if not already awake).

If false is returned, afterScheduledTaskSubmitted(long) will be called with the same value after the scheduled task is enqueued, providing another opportunity to wake the EventExecutor thread if required.

Parameters

deadlineNanos:long: deadline of the to-be-scheduled task relative to AbstractScheduledEventExecutor#getCurrentTimeNanos()

Returns:boolean

true if the EventExecutor thread should be woken, false otherwise

Annotations

@Override

cleanDatagramPacketArray	back to summary
pack-priv NativeDatagramPacketArray cleanDatagramPacketArray() Return a cleared `NativeDatagramPacketArray` that can be used for writes in this `EventLoop`.

cleanIovArray	back to summary
pack-priv IovArray cleanIovArray() Return a cleared `IovArray` that can be used for writes in this `EventLoop`.

cleanup	back to summary
protected void cleanup() Overrides io.netty.util.concurrent.SingleThreadEventExecutor.cleanup. Doc from io.netty.util.concurrent.SingleThreadEventExecutor.cleanup. Do nothing, sub-classes may override Annotations @Override

cleanup

back to summary

protected void cleanup()

Overrides io.netty.util.concurrent.SingleThreadEventExecutor.cleanup.

Doc from io.netty.util.concurrent.SingleThreadEventExecutor.cleanup.

Do nothing, sub-classes may override

Annotations

@Override

closeAll	back to summary
private void closeAll()

closeFileDescriptors	back to summary
public void closeFileDescriptors() This method is intended for use by process checkpoint/restore integration, such as OpenJDK CRaC. It's up to the caller to ensure that there is no concurrent use of the FDs while these are closed, e.g. by blocking the executor. Annotations @UnstableApi

closeFileDescriptors

back to summary

public void closeFileDescriptors()

This method is intended for use by process checkpoint/restore integration, such as OpenJDK CRaC. It's up to the caller to ensure that there is no concurrent use of the FDs while these are closed, e.g. by blocking the executor.

Annotations

@UnstableApi

epollBusyWait	back to summary
private int epollBusyWait() throws IOException

epollWait	back to summary
private long epollWait(long deadlineNanos) throws IOException

epollWaitNoTimerChange	back to summary
private int epollWaitNoTimerChange() throws IOException

epollWaitNow	back to summary
private int epollWaitNow() throws IOException

epollWaitTimeboxed	back to summary
private int epollWaitTimeboxed() throws IOException

getIoRatio	back to summary
public int getIoRatio() Returns the percentage of the desired amount of time spent for I/O in the event loop.

handleLoopException	back to summary
pack-priv void handleLoopException(Throwable t) Visible only for testing!

modify	back to summary
pack-priv void modify(AbstractEpollChannel ch) throws IOException The flags of the given epoll was modified so update the registration

newTaskQueue	back to summary
private static Queue<Runnable> newTaskQueue(EventLoopTaskQueueFactory queueFactory)

newTaskQueue back to summary

newTaskQueue	back to summary
protected Queue<Runnable> newTaskQueue(int maxPendingTasks) Overrides io.netty.util.concurrent.SingleThreadEventExecutor.newTaskQueue. Doc from io.netty.util.concurrent.SingleThreadEventExecutor.newTaskQueue. 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. Annotations @Override

protected Queue<Runnable> newTaskQueue(int maxPendingTasks)

Overrides io.netty.util.concurrent.SingleThreadEventExecutor.newTaskQueue.

Doc from io.netty.util.concurrent.SingleThreadEventExecutor.newTaskQueue.

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.

Annotations

@Override

newTaskQueue0	back to summary
private static Queue<Runnable> newTaskQueue0(int maxPendingTasks)

openFileDescriptors	back to summary
public void openFileDescriptors() This method is intended for use by a process checkpoint/restore integration, such as OpenJDK CRaC. Annotations @UnstableApi

openFileDescriptors

back to summary

public void openFileDescriptors()

This method is intended for use by a process checkpoint/restore integration, such as OpenJDK CRaC.

Annotations

@UnstableApi

processReady	back to summary
private boolean processReady(EpollEventArray events, int ready)

registeredChannels back to summary

registeredChannels	back to summary
public int registeredChannels() Overrides io.netty.channel.SingleThreadEventLoop.registeredChannels. Doc from io.netty.channel.SingleThreadEventLoop.registeredChannels. Returns the number of `Channel`s registered with this `EventLoop` or `-1` if operation is not supported. The returned value is not guaranteed to be exact accurate and should be viewed as a best effort. Annotations @Override

public int registeredChannels()

Overrides io.netty.channel.SingleThreadEventLoop.registeredChannels.

Doc from io.netty.channel.SingleThreadEventLoop.registeredChannels.

Returns the number of Channels registered with this EventLoop or -1 if operation is not supported. The returned value is not guaranteed to be exact accurate and should be viewed as a best effort.

Annotations

@Override

registeredChannelsIterator back to summary

registeredChannelsIterator	back to summary
public Iterator<Channel> registeredChannelsIterator() Overrides io.netty.channel.SingleThreadEventLoop.registeredChannelsIterator. Returns:Iterator<Channel> Doc from io.netty.channel.SingleThreadEventLoop.registeredChannelsIterator. read-only iterator of active `Channel`s registered with this `EventLoop`. The returned value is not guaranteed to be exact accurate and should be viewed as a best effort. This method is expected to be called from within event loop. Annotations @Override

public Iterator<Channel> registeredChannelsIterator()

Overrides io.netty.channel.SingleThreadEventLoop.registeredChannelsIterator.

Returns:Iterator<Channel>

Doc from io.netty.channel.SingleThreadEventLoop.registeredChannelsIterator.

read-only iterator of active Channels registered with this EventLoop. The returned value is not guaranteed to be exact accurate and should be viewed as a best effort. This method is expected to be called from within event loop.

Annotations

@Override

remove	back to summary
pack-priv void remove(AbstractEpollChannel ch) throws IOException Deregister the given epoll from this `EventLoop`.

run back to summary

run	back to summary
protected void run() Implements abstract io.netty.util.concurrent.SingleThreadEventExecutor.run. Doc from io.netty.util.concurrent.SingleThreadEventExecutor.run. Run the tasks in the `taskQueue` Annotations @Override

protected void run()

Implements abstract io.netty.util.concurrent.SingleThreadEventExecutor.run.

Doc from io.netty.util.concurrent.SingleThreadEventExecutor.run.

Run the tasks in the taskQueue

Annotations

@Override

setIoRatio	back to summary
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.

wakeup	back to summary
protected void wakeup(boolean inEventLoop) Overrides io.netty.util.concurrent.SingleThreadEventExecutor.wakeup. Annotations @Override

wakeup

back to summary

protected void wakeup(boolean inEventLoop)

Overrides io.netty.util.concurrent.SingleThreadEventExecutor.wakeup.

Annotations

@Override

public Class EpollEventLoop

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail