Class IoUringIoHandler

java.lang.Object

io.netty.channel.uring.IoUringIoHandler

All Implemented Interfaces:

IoHandler

public final class IoUringIoHandler
extends Object
implements IoHandler

IoHandler which is implemented in terms of the Linux-specific io_uring API.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy the IoHandler and free all its resources.
void	initialize()	Initialize this IoHandler.
boolean	isCompatible(Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoHandler and so can be registered, false otherwise.
static IoHandlerFactory	newFactory()	Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.
static IoHandlerFactory	newFactory(int ringSize)	Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.
static IoHandlerFactory	newFactory(IoUringIoHandlerConfig config)	Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.
void	prepareToDestroy()	Prepare to destroy this IoHandler.
IoRegistration	register(IoHandle handle)	Register a IoHandle for IO.
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.

Methods inherited from class Object

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

Method Details

initialize

public void initialize()

Description copied from interface: IoHandler

Initialize this IoHandler.

Specified by:

initialize in interface IoHandler

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.

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)
                        throws Exception

Description copied from interface: IoHandler

Register a IoHandle for IO.

Specified by:

register in interface IoHandler

Parameters:

handle - the IoHandle to register.

Throws:

Exception - thrown if an error happens during registration.

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

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.

newFactory

public static IoHandlerFactory newFactory()

Create a new IoHandlerFactory that can be used to create IoUringIoHandlers.

Returns:

factory

newFactory

public static IoHandlerFactory newFactory(int ringSize)

Create a new IoHandlerFactory that can be used to create IoUringIoHandlers. Each IoUringIoHandler will use a ring of size ringSize.

Parameters:

ringSize - the size of the ring.

Returns:

factory

newFactory

public static IoHandlerFactory newFactory(IoUringIoHandlerConfig config)

Create a new IoHandlerFactory that can be used to create IoUringIoHandlers. Each IoUringIoHandler will use same option

Parameters:

config - the io_uring configuration

Returns:

factory