Package io.netty.channel.kqueue

Class KQueueEventLoop

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.kqueue.KQueueEventLoop

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 KQueueEventLoop
extends SingleThreadEventLoop

EventLoop which uses kqueue under the covers. Only works on BSD!

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	KQueueEventLoop.KQueueRegistration

Nested classes/interfaces inherited from class io.netty.channel.SingleThreadEventLoop

SingleThreadEventLoop.ChannelsReadOnlyIterator<T extends Channel>

Nested classes/interfaces inherited from class io.netty.util.concurrent.SingleThreadEventExecutor

SingleThreadEventExecutor.NonWakeupRunnable

Nested classes/interfaces inherited from class io.netty.util.concurrent.AbstractEventExecutor

AbstractEventExecutor.LazyRunnable

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowGrowing
private java.util.Queue<KQueueEventLoop.KQueueRegistration>	cancelledRegistrations
private KQueueEventArray	changeList
private KQueueEventArray	eventList
private int	ioRatio
private IovArray	iovArray
private static int	KQUEUE_MAX_TIMEOUT_SECONDS
private static int	KQUEUE_WAKE_UP_IDENT
private FileDescriptor	kqueueFd
private static InternalLogger	logger
private long	nextId
private LongObjectMap<KQueueEventLoop.KQueueRegistration>	registrations
private IntSupplier	selectNowSupplier
private SelectStrategy	selectStrategy
private static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<KQueueEventLoop>	WAKEN_UP_UPDATER
private int	wakenUp

Fields inherited from class io.netty.channel.SingleThreadEventLoop

DEFAULT_MAX_PENDING_TASKS

Constructor Summary

Constructors

Constructor	Description
KQueueEventLoop(EventLoopGroup parent, java.util.concurrent.Executor executor, int maxEvents, SelectStrategy strategy, RejectedExecutionHandler rejectedExecutionHandler, EventLoopTaskQueueFactory taskQueueFactory, EventLoopTaskQueueFactory tailTaskQueueFactory)

Method Summary

Modifier and Type	Method	Description
(package private) KQueueEventLoop.KQueueRegistration	add(AbstractKQueueChannel ch)
(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 long	generateNextId()
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)
private int	kqueueWait(boolean oldWakeup)
private int	kqueueWait(int timeoutSec, int timeoutNs)
private int	kqueueWaitNow()
protected java.util.Queue<java.lang.Runnable>	newTaskQueue(int maxPendingTasks)	Create a new Queue which will holds the tasks to execute.
private static java.util.Queue<java.lang.Runnable>	newTaskQueue(EventLoopTaskQueueFactory queueFactory)
private static java.util.Queue<java.lang.Runnable>	newTaskQueue0(int maxPendingTasks)
private void	processCancelledRegistrations()
private void	processReady(int ready)
int	registeredChannels()	Returns the number of Channels registered with this EventLoop or -1 if operation is not supported.
java.util.Iterator<Channel>	registeredChannelsIterator()
protected void	run()	Runs the task-processing loop until SingleThreadEventExecutor.confirmShutdown() returns true.
void	setIoRatio(int ioRatio)	Sets the percentage of the desired amount of time spent for I/O in the event loop.
private void	wakeup()
protected void	wakeup(boolean inEventLoop)

Methods inherited from class io.netty.channel.SingleThreadEventLoop

afterRunningAllTasks, executeAfterEventLoopIteration, hasTasks, next, parent, pendingTasks, register, register, register

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

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

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

afterScheduledTaskSubmitted, beforeScheduledTaskSubmitted, cancelScheduledTasks, deadlineToDelayNanos, getCurrentTimeNanos, hasScheduledTasks, initialNanoTime, nanoTime, nextScheduledTaskDeadlineNanos, nextScheduledTaskNano, pollScheduledTask, pollScheduledTask, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, validateScheduled

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

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

execute

Methods inherited from interface java.util.concurrent.ExecutorService

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

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<KQueueEventLoop> WAKEN_UP_UPDATER

KQUEUE_WAKE_UP_IDENT

private static final int KQUEUE_WAKE_UP_IDENT

See Also:

Constant Field Values

KQUEUE_MAX_TIMEOUT_SECONDS

private static final int KQUEUE_MAX_TIMEOUT_SECONDS

See Also:

Constant Field Values

allowGrowing

private final boolean allowGrowing

kqueueFd

private final FileDescriptor kqueueFd

changeList

private final KQueueEventArray changeList

eventList

private final KQueueEventArray eventList

selectStrategy

private final SelectStrategy selectStrategy

iovArray

private final IovArray iovArray

selectNowSupplier

private final IntSupplier selectNowSupplier

registrations

private final LongObjectMap<KQueueEventLoop.KQueueRegistration> registrations

cancelledRegistrations

private final java.util.Queue<KQueueEventLoop.KQueueRegistration> cancelledRegistrations

nextId

private long nextId

wakenUp

private volatile int wakenUp

ioRatio

private volatile int ioRatio

Constructor Detail

KQueueEventLoop

KQueueEventLoop(EventLoopGroup parent,
                java.util.concurrent.Executor executor,
                int maxEvents,
                SelectStrategy strategy,
                RejectedExecutionHandler rejectedExecutionHandler,
                EventLoopTaskQueueFactory taskQueueFactory,
                EventLoopTaskQueueFactory tailTaskQueueFactory)

Method Detail

newTaskQueue

private static java.util.Queue<java.lang.Runnable> newTaskQueue(EventLoopTaskQueueFactory queueFactory)

generateNextId

private long generateNextId()

processCancelledRegistrations

private void processCancelledRegistrations()

add

KQueueEventLoop.KQueueRegistration add(AbstractKQueueChannel ch)

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

wakeup

private void wakeup()

kqueueWait

private int kqueueWait(boolean oldWakeup)
                throws java.io.IOException

Throws:

java.io.IOException

kqueueWaitNow

private int kqueueWaitNow()
                   throws java.io.IOException

Throws:

java.io.IOException

kqueueWait

private int kqueueWait(int timeoutSec,
                       int timeoutNs)
                throws java.io.IOException

Throws:

java.io.IOException

processReady

private void processReady(int ready)

run

protected void run()

Description copied from class: SingleThreadEventExecutor

Runs the task-processing loop until SingleThreadEventExecutor.confirmShutdown() returns true.

Implementations must not let a Throwable thrown by a task escape this method: any uncaught Throwable terminates the executor (logged at WARN and surfaced via SingleThreadEventExecutor.terminationFuture()), at which point every Channel registered with this executor stops processing I/O and new task submissions are rejected. The supplied helpers - SingleThreadEventExecutor.runAllTasks(), SingleThreadEventExecutor.runAllTasks(long), and AbstractEventExecutor.safeExecute(Runnable) - catch Throwable for you; custom loops built on SingleThreadEventExecutor.pollTask() or SingleThreadEventExecutor.takeTask() are responsible for wrapping each task invocation accordingly.

Specified by:

run in class SingleThreadEventExecutor

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

newTaskQueue0

private static java.util.Queue<java.lang.Runnable> newTaskQueue0(int maxPendingTasks)

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.

registeredChannels

public int registeredChannels()

Description copied from class: SingleThreadEventLoop

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.

Overrides:

registeredChannels in class SingleThreadEventLoop

registeredChannelsIterator

public java.util.Iterator<Channel> registeredChannelsIterator()

Overrides:

registeredChannelsIterator in class SingleThreadEventLoop

Returns:

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.

cleanup

protected void cleanup()

Description copied from class: SingleThreadEventExecutor

Do nothing, sub-classes may override

Overrides:

cleanup in class SingleThreadEventExecutor

closeAll

private void closeAll()

handleLoopException

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