Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	NioEventLoop.SelectorTuple

Field Summary

Modifier and Type	Field and Description
private static final long	AWAKE
private int	cancelledKeys
private static final int	CLEANUP_INTERVAL
private static final boolean	DISABLE_KEY_SET_OPTIMIZATION
private volatile int	ioRatio
private static final InternalLogger	logger Hides io.netty.util.concurrent.SingleThreadEventExecutor.logger.
private static final int	MIN_PREMATURE_SELECTOR_RETURNS
private boolean	needsToSelectAgain
private final AtomicLong	nextWakeupNanos
private static final long	NONE
private final SelectorProvider	provider
private SelectedSelectionKeySet	selectedKeys
private final IntSupplier	selectNowSupplier
private Selector	selector The NIO `Selector`.
private static final int	SELECTOR_AUTO_REBUILD_THRESHOLD
private final SelectStrategy	selectStrategy
private Selector	unwrappedSelector

Inherited from io.netty.channel.SingleThreadEventLoop:: DEFAULT_MAX_PENDING_TASKS

Constructor Summary

Access	Constructor and Description
pack-priv	NioEventLoop(NioEventLoopGroup parent, Executor executor, SelectorProvider selectorProvider, SelectStrategy strategy, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory taskQueueFactory, EventLoopTaskQueueFactory tailTaskQueueFactory)

Method Summary

Modifier and Type	Method and Description
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 void	cancel(SelectionKey key)
protected void	cleanup() Overrides io.netty.util.concurrent.SingleThreadEventExecutor.cleanup. Do nothing, sub-classes may override
private void	closeAll()
public int	getIoRatio() Returns the percentage of the desired amount of time spent for I/O in the event loop.
private static void	handleLoopException(Throwable t)
private static void	invokeChannelUnregistered(NioTask<SelectableChannel> task, SelectionKey k, Throwable cause)
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)
private NioEventLoop.SelectorTuple	openSelector()
private void	processSelectedKey(SelectionKey k, AbstractNioChannel ch)
private static void	processSelectedKey(SelectionKey k, NioTask<SelectableChannel> task)
private void	processSelectedKeys()
private void	processSelectedKeysOptimized()
private void	processSelectedKeysPlain(Set<SelectionKey> selectedKeys)
public void	rebuildSelector() Replaces the current `Selector` of this event loop with newly created `Selector`s to work around the infamous epoll 100% CPU bug.
private void	rebuildSelector0()
public void	register(final SelectableChannel ch, final int interestOps, final NioTask<?> task) Registers an arbitrary `SelectableChannel`, not necessarily created by Netty, to the `Selector` of this event loop.
private void	register0(SelectableChannel ch, int interestOps, NioTask<?> task)
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.
protected void	run() Implements abstract io.netty.util.concurrent.SingleThreadEventExecutor.run. Run the tasks in the `taskQueue`
private int	select(long deadlineNanos)
private void	selectAgain()
pack-priv int	selectNow()
public SelectorProvider	selectorProvider() Returns the `SelectorProvider` used by this `NioEventLoop` to obtain the `Selector`.
public void	setIoRatio(int ioRatio) Sets the percentage of the desired amount of time spent for I/O in the event loop.
private boolean	unexpectedSelectorWakeup(int selectCnt)
pack-priv Selector	unwrappedSelector()
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

Field Detail

AWAKE	back to summary
private static final long AWAKE

cancelledKeys	back to summary
private int cancelledKeys

CLEANUP_INTERVAL	back to summary
private static final int CLEANUP_INTERVAL

DISABLE_KEY_SET_OPTIMIZATION	back to summary
private static final boolean DISABLE_KEY_SET_OPTIMIZATION

ioRatio	back to summary
private volatile int ioRatio

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

MIN_PREMATURE_SELECTOR_RETURNS	back to summary
private static final int MIN_PREMATURE_SELECTOR_RETURNS

needsToSelectAgain	back to summary
private boolean needsToSelectAgain

nextWakeupNanos	back to summary
private final AtomicLong nextWakeupNanos

NONE	back to summary
private static final long NONE

provider	back to summary
private final SelectorProvider provider

selectedKeys	back to summary
private SelectedSelectionKeySet selectedKeys

selectNowSupplier	back to summary
private final IntSupplier selectNowSupplier

selector	back to summary
private Selector selector The NIO `Selector`.

SELECTOR_AUTO_REBUILD_THRESHOLD	back to summary
private static final int SELECTOR_AUTO_REBUILD_THRESHOLD

selectStrategy	back to summary
private final SelectStrategy selectStrategy

unwrappedSelector	back to summary
private Selector unwrappedSelector

Constructor Detail

NioEventLoop	back to summary
pack-priv NioEventLoop(NioEventLoopGroup parent, Executor executor, SelectorProvider selectorProvider, SelectStrategy strategy, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory taskQueueFactory, EventLoopTaskQueueFactory tailTaskQueueFactory)

Method Detail

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

cancel	back to summary
pack-priv void cancel(SelectionKey key)

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()

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
private static void handleLoopException(Throwable t)

invokeChannelUnregistered	back to summary
private static void invokeChannelUnregistered(NioTask<SelectableChannel> task, SelectionKey k, Throwable cause)

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)

openSelector	back to summary
private NioEventLoop.SelectorTuple openSelector()

processSelectedKey	back to summary
private void processSelectedKey(SelectionKey k, AbstractNioChannel ch)

processSelectedKey	back to summary
private static void processSelectedKey(SelectionKey k, NioTask<SelectableChannel> task)

processSelectedKeys	back to summary
private void processSelectedKeys()

processSelectedKeysOptimized	back to summary
private void processSelectedKeysOptimized()

processSelectedKeysPlain	back to summary
private void processSelectedKeysPlain(Set<SelectionKey> selectedKeys)

rebuildSelector	back to summary
public void rebuildSelector() Replaces the current `Selector` of this event loop with newly created `Selector`s to work around the infamous epoll 100% CPU bug.

rebuildSelector0	back to summary
private void rebuildSelector0()

register	back to summary
public void register(final SelectableChannel ch, final int interestOps, final NioTask<?> task) Registers an arbitrary `SelectableChannel`, not necessarily created by Netty, to the `Selector` of this event loop. Once the specified `SelectableChannel` is registered, the specified `task` will be executed by this event loop when the `SelectableChannel` is ready.

register0	back to summary
private void register0(SelectableChannel ch, int interestOps, NioTask<?> task)

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

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

select	back to summary
private int select(long deadlineNanos) throws IOException

selectAgain	back to summary
private void selectAgain()

selectNow	back to summary
pack-priv int selectNow() throws IOException

selectorProvider	back to summary
public SelectorProvider selectorProvider() Returns the `SelectorProvider` used by this `NioEventLoop` to obtain the `Selector`.

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. Value range from 1-100. 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. The lower the number the more time can be spent on non-I/O tasks. If value set to 100, this feature will be disabled and event loop will not attempt to balance I/O and non-I/O tasks.

unexpectedSelectorWakeup	back to summary
private boolean unexpectedSelectorWakeup(int selectCnt)

unwrappedSelector	back to summary
pack-priv Selector unwrappedSelector()

wakeup

back to summary

protected void wakeup(boolean inEventLoop)

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

Annotations

@Override

io.netty.channel.nio back to summary

private final Class NioEventLoop.SelectorTuple

Class Inheritance

extends Object

java.lang.Object
io.netty.channel.nio.NioEventLoop.SelectorTuple

Field Summary

Modifier and Type	Field and Description
pack-priv final Selector	selector
pack-priv final Selector	unwrappedSelector

Constructor Summary

Access	Constructor and Description
pack-priv	SelectorTuple(Selector unwrappedSelector)
pack-priv	SelectorTuple(Selector unwrappedSelector, Selector selector)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

selector	back to summary
pack-priv final Selector selector

unwrappedSelector	back to summary
pack-priv final Selector unwrappedSelector

Constructor Detail

SelectorTuple	back to summary
pack-priv SelectorTuple(Selector unwrappedSelector)

SelectorTuple	back to summary
pack-priv SelectorTuple(Selector unwrappedSelector, Selector selector)

public final Class NioEventLoop

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class NioEventLoop.SelectorTuple

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail