Module io.netty5.transport.classes.epoll

Package io.netty5.channel.epoll

Class EpollHandler

java.lang.Object

io.netty5.channel.epoll.EpollHandler

All Implemented Interfaces:

IoHandler

public class EpollHandler
extends Object
implements IoHandler

IoHandler which uses epoll under the covers. Only works on Linux!

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.
static IoHandlerFactory	newFactory()	Returns a new IoHandlerFactory that creates EpollHandler instances.
static IoHandlerFactory	newFactory(int maxEvents, SelectStrategyFactory selectStrategyFactory)	Returns a new IoHandlerFactory that creates EpollHandler instances.
void	prepareToDestroy()	Prepare to destroy this IoHandler.
void	register(IoHandle handle)	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.

Methods inherited from class java.lang.Object

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

Method Detail

newFactory

public static IoHandlerFactory newFactory()

Returns a new IoHandlerFactory that creates EpollHandler instances.

newFactory

public static IoHandlerFactory newFactory(int maxEvents,
                                          SelectStrategyFactory selectStrategyFactory)

Returns a new IoHandlerFactory that creates EpollHandler instances.

register

public final void register(IoHandle handle)
                    throws Exception

Description copied from interface: IoHandler

Register a Channel for IO.

Specified by:

register in interface IoHandler

Parameters:

handle - the Channel to register..

Throws:

Exception - thrown if an error happens during registration.

deregister

public final void deregister(IoHandle handle)
                      throws Exception

Description copied from interface: IoHandler

Deregister a IoHandle for IO.

Specified by:

deregister in interface IoHandler

Parameters:

handle - the IoHandle to deregister..

Throws:

Exception - thrown if an error happens during deregistration.

wakeup

public final void wakeup(boolean inEventLoop)

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

run

public final int run(IoExecutionContext context)

Description copied from interface: IoHandler

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.

Specified by:

run in interface IoHandler

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 final void destroy()

Description copied from interface: IoHandler

Destroy the IoHandler and free all its resources.

Specified by:

destroy 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.