Class KQueueIoHandler

java.lang.Object

io.netty.channel.kqueue.KQueueIoHandler

All Implemented Interfaces:

IoHandler

public final class KQueueIoHandler
extends Object
implements IoHandler

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	KQueueIoHandler.DefaultKqueueIoRegistration

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowGrowing
private final Queue<KQueueIoHandler.DefaultKqueueIoRegistration>	cancelledRegistrations
private final KQueueEventArray	changeList
private final KQueueEventArray	eventList
private final ThreadAwareExecutor	executor
private static final int	KQUEUE_MAX_TIMEOUT_SECONDS
private static final int	KQUEUE_WAKE_UP_IDENT
private final FileDescriptor	kqueueFd
private static final InternalLogger	logger
private final NativeArrays	nativeArrays
private long	nextId
private int	numChannels
private final LongObjectMap<KQueueIoHandler.DefaultKqueueIoRegistration>	registrations
private final IntSupplier	selectNowSupplier
private final SelectStrategy	selectStrategy
private static final AtomicIntegerFieldUpdater<KQueueIoHandler>	WAKEN_UP_UPDATER
private int	wakenUp

Constructor Summary

Constructors

Modifier	Constructor	Description
private	KQueueIoHandler(ThreadAwareExecutor executor, int maxEvents, SelectStrategy strategy)

Method Summary

Modifier and Type	Method	Description
private static KQueueIoHandle	cast(IoHandle handle)
private static KQueueIoOps	cast(IoOps ops)
void	destroy()	Destroy the IoHandler and free all its resources.
private long	generateNextId()
private static void	handleLoopException(Throwable t)
boolean	isCompatible(Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoHandler and so can be registered, false otherwise.
private int	kqueueWait(int timeoutSec, int timeoutNs)
private int	kqueueWait(IoHandlerContext context, boolean oldWakeup)
private int	kqueueWaitNow()
static IoHandlerFactory	newFactory()	Returns a new IoHandlerFactory that creates KQueueIoHandler instances.
static IoHandlerFactory	newFactory(int maxEvents, SelectStrategyFactory selectStrategyFactory)	Returns a new IoHandlerFactory that creates KQueueIoHandler instances.
(package private) int	numRegisteredChannels()
void	prepareToDestroy()	Prepare to destroy this IoHandler.
private void	processCancelledRegistrations()
private int	processReady(int ready)
IoRegistration	register(IoHandle handle)	Register a IoHandle for IO.
(package private) List<Channel>	registeredChannelsList()
int	run(IoHandlerContext context)	Run the IO handled by this IoHandler.
void	wakeup()	Wakeup the IoHandler, which means if any operation blocks it should be unblocked and return as soon as possible.
private void	wakeup0()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IoHandler

initialize

Field Details

logger

private static final InternalLogger logger

WAKEN_UP_UPDATER

private static final AtomicIntegerFieldUpdater<KQueueIoHandler> 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

nativeArrays

private final NativeArrays nativeArrays

selectNowSupplier

private final IntSupplier selectNowSupplier

executor

private final ThreadAwareExecutor executor

cancelledRegistrations

private final Queue<KQueueIoHandler.DefaultKqueueIoRegistration> cancelledRegistrations

registrations

private final LongObjectMap<KQueueIoHandler.DefaultKqueueIoRegistration> registrations

numChannels

private int numChannels

nextId

private long nextId

wakenUp

private volatile int wakenUp

Constructor Details

KQueueIoHandler

private KQueueIoHandler(ThreadAwareExecutor executor,
 int maxEvents,
 SelectStrategy strategy)

Method Details

generateNextId

private long generateNextId()

newFactory

public static IoHandlerFactory newFactory()

Returns a new IoHandlerFactory that creates KQueueIoHandler instances.

newFactory

public static IoHandlerFactory newFactory(int maxEvents,
 SelectStrategyFactory selectStrategyFactory)

Returns a new IoHandlerFactory that creates KQueueIoHandler instances.

wakeup

public void wakeup()

Description copied from interface: IoHandler

Wakeup the IoHandler, which means if any operation blocks it should be unblocked and return as soon as possible.

Specified by:

wakeup in interface IoHandler

wakeup0

private void wakeup0()

kqueueWait

private int kqueueWait(IoHandlerContext context,
 boolean oldWakeup)
                throws IOException

Throws:

IOException

kqueueWaitNow

private int kqueueWaitNow()
                   throws IOException

Throws:

IOException

kqueueWait

private int kqueueWait(int timeoutSec,
 int timeoutNs)
                throws IOException

Throws:

IOException

processReady

private int processReady(int ready)

run

public int run(IoHandlerContext context)

Description copied from interface: IoHandler

Run the IO handled by this IoHandler. The IoHandlerContext should be used to ensure we not execute too long and so block the processing of other task that are scheduled on the ThreadAwareExecutor. This is done by taking IoHandlerContext.delayNanos(long) or IoHandlerContext.deadlineNanos() into account.

Specified by:

run in interface IoHandler

Parameters:

context - the IoHandlerContext.

Returns:

the number of IoHandle for which I/O was handled. Internal events such as wakeups and timer expirations must not be included in this count.

processCancelledRegistrations

private void processCancelledRegistrations()

numRegisteredChannels

int numRegisteredChannels()

registeredChannelsList

List<Channel> registeredChannelsList()

handleLoopException

private static void handleLoopException(Throwable t)

prepareToDestroy

public void prepareToDestroy()

Description copied from interface: IoHandler

Prepare to destroy this IoHandler. This method will be called before IoHandler.destroy() and may be called multiple times.

Specified by:

prepareToDestroy in interface IoHandler

destroy

public void destroy()

Description copied from interface: IoHandler

Destroy the IoHandler and free all its resources. Once destroyed using the IoHandler will cause undefined behaviour.

Specified by:

destroy in interface IoHandler

register

public IoRegistration register(IoHandle handle)

Description copied from interface: IoHandler

Register a IoHandle for IO.

Specified by:

register in interface IoHandler

Parameters:

handle - the IoHandle to register.

cast

private static KQueueIoHandle cast(IoHandle handle)

cast

private static KQueueIoOps cast(IoOps ops)

isCompatible

public boolean isCompatible(Class<? extends IoHandle> handleType)

Description copied from interface: IoHandler

Returns true if the given type is compatible with this IoHandler and so can be registered, false otherwise.

Specified by:

isCompatible in interface IoHandler

Parameters:

handleType - the type of the IoHandle.

Returns:

if compatible of not.