Module io.netty5.transport

Package io.netty5.channel

Interface IoHandler

All Known Implementing Classes:

EpollHandler, KQueueHandler, LocalHandler, NioHandler

public interface IoHandler

Handles IO dispatching for an EventLoop All operations except wakeup(boolean) and isCompatible(Class) MUST be executed on the EventLoop thread and should never be called from the user-directly.

Method Summary

Modifier and Type	Method	Description
void	deregister(IoHandle handle)	Deregister a IoHandle for IO.
void	destroy()	Destroy the IoHandler and free all its resources.
boolean	isCompatible(Class<? extends IoHandle> handleType)	Returns true if the given type is compatible with this IoHandler and so can be registered, false otherwise.
void	prepareToDestroy()	Prepare to destroy this IoHandler.
void	register(IoHandle channel)	Register a Channel for IO.
int	run(IoExecutionContext context)	Run the IO handled by this IoHandler.
void	wakeup(boolean inEventLoop)	Wakeup the IoHandler, which means if any operation blocks it should be unblocked and return as soon as possible.

Method Detail

run

int run(IoExecutionContext context)

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

Returns:

the number of IoHandle for which I/O was handled.

prepareToDestroy

void prepareToDestroy()

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

destroy

void destroy()

Destroy the IoHandler and free all its resources.

register

void register(IoHandle channel)
       throws Exception

Register a Channel for IO.

Parameters:

channel - the Channel to register..

Throws:

Exception - thrown if an error happens during registration.

deregister

void deregister(IoHandle handle)
         throws Exception

Deregister a IoHandle for IO.

Parameters:

handle - the IoHandle to deregister..

Throws:

Exception - thrown if an error happens during deregistration.

wakeup

void wakeup(boolean inEventLoop)

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

isCompatible

boolean isCompatible(Class<? extends IoHandle> handleType)

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

Parameters:

handleType - the type of the IoHandle.

Returns:

if compatible of not.