io.netty.channel.local

Class LocalIoHandler

java.lang.Object

io.netty.channel.local.LocalIoHandler

All Implemented Interfaces:

IoHandler

public final class LocalIoHandler
extends Object
implements IoHandler

Method Summary

Modifier and Type	Method and Description
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 LocalIoHandler instances.
void	prepareToDestroy() Prepare to destroy this IoHandler.
IoRegistration	register(IoEventLoop eventLoop, IoHandle handle) Register a IoHandle for IO.
int	run(IoExecutionContext runner) Run the IO handled by this IoHandler.
void	wakeup(IoEventLoop eventLoop) 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 LocalIoHandler instances.

run

public int run(IoExecutionContext runner)

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.

wakeup

public void wakeup(IoEventLoop eventLoop)

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

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(IoEventLoop eventLoop,
                               IoHandle handle)

Description copied from interface: IoHandler

Register a IoHandle for IO.

Specified by:

register in interface IoHandler

Parameters:

eventLoop - the IoEventLoop that did issue the registration.

handle - the IoHandle to register.

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.