Module io.netty5.transport

Package io.netty5.channel

Class SimpleUserEventChannelHandler<I>

java.lang.Object

io.netty5.channel.SimpleUserEventChannelHandler<I>

All Implemented Interfaces:

ChannelHandler

public abstract class SimpleUserEventChannelHandler<I>
extends Object
implements ChannelHandler

ChannelHandler which allows to conveniently only handle a specific type of user events. For example, here is an implementation which only handle String user events.

     public class StringEventHandler extends
             SimpleUserEventChannelHandler<String> {

         @Override
         protected void eventReceived(ChannelHandlerContext ctx, String evt)
                 throws Exception {
             System.out.println(evt);
         }
     }
 

Be aware that depending of the constructor parameters it will release all handled events by passing them to Resource.dispose(Object).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleUserEventChannelHandler()	see SimpleUserEventChannelHandler(boolean) with true as boolean parameter.
protected	SimpleUserEventChannelHandler(boolean autoRelease)	Create a new instance which will try to detect the types to match out of the type parameter of the class.
protected	SimpleUserEventChannelHandler(Class<? extends I> eventType)	see SimpleUserEventChannelHandler(Class, boolean) with true as boolean value.
protected	SimpleUserEventChannelHandler(Class<? extends I> eventType, boolean autoRelease)	Create a new instance

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptEvent(Object evt)	Returns true if the given user event should be handled.
void	channelInboundEvent(ChannelHandlerContext ctx, Object evt)	Gets called if a custom inbound event happened.
protected abstract void	eventReceived(ChannelHandlerContext ctx, I evt)	Is called for each user event triggered of type SimpleUserEventChannelHandler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelExceptionCaught, channelInactive, channelRead, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

Constructor Detail

SimpleUserEventChannelHandler

protected SimpleUserEventChannelHandler()

see SimpleUserEventChannelHandler(boolean) with true as boolean parameter.

SimpleUserEventChannelHandler

protected SimpleUserEventChannelHandler(boolean autoRelease)

Create a new instance which will try to detect the types to match out of the type parameter of the class.

Parameters:

autoRelease - true if handled events should be released automatically by passing them to Resource.dispose(Object).

SimpleUserEventChannelHandler

protected SimpleUserEventChannelHandler(Class<? extends I> eventType)

see SimpleUserEventChannelHandler(Class, boolean) with true as boolean value.

SimpleUserEventChannelHandler

protected SimpleUserEventChannelHandler(Class<? extends I> eventType,
                                        boolean autoRelease)

Create a new instance

Parameters:

eventType - The type of events to match

autoRelease - true if handled events should be released automatically by passing them to Resource.dispose(Object).

Method Detail

acceptEvent

protected boolean acceptEvent(Object evt)
                       throws Exception

Returns true if the given user event should be handled. If false it will be passed to the next ChannelHandler in the ChannelPipeline.

Throws:

Exception

channelInboundEvent

public final void channelInboundEvent(ChannelHandlerContext ctx,
                                      Object evt)
                               throws Exception

Description copied from interface: ChannelHandler

Gets called if a custom inbound event happened.

Specified by:

channelInboundEvent in interface ChannelHandler

Throws:

Exception

eventReceived

protected abstract void eventReceived(ChannelHandlerContext ctx,
                                      I evt)
                               throws Exception

Is called for each user event triggered of type SimpleUserEventChannelHandler.

Parameters:

ctx - the ChannelHandlerContext which this SimpleUserEventChannelHandler belongs to

evt - the user event to handle

Throws:

Exception - is thrown if an error occurred