io.netty.channel

类 SimpleUserEventChannelHandler<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleUserEventChannelHandler<I>

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

public abstract class SimpleUserEventChannelHandler<I>
extends ChannelInboundHandlerAdapter

ChannelInboundHandlerAdapter 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 ReferenceCountUtil.release(Object). In this case you may need to use ReferenceCountUtil.retain(Object) if you pass the object to the next handler in the ChannelPipeline.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

限定符	构造器和说明
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(java.lang.Class<? extends I> eventType) see SimpleUserEventChannelHandler(Class, boolean) with true as boolean value.
protected	SimpleUserEventChannelHandler(java.lang.Class<? extends I> eventType, boolean autoRelease) Create a new instance

方法概要

限定符和类型	方法和说明
protected boolean	acceptEvent(java.lang.Object evt) Returns true if the given user event should be handled.
protected abstract void	eventReceived(ChannelHandlerContext ctx, I evt) Is called for each user event triggered of type I.
void	userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt) Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

构造器详细资料

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.

参数:

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

SimpleUserEventChannelHandler

protected SimpleUserEventChannelHandler(java.lang.Class<? extends I> eventType)

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

SimpleUserEventChannelHandler

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

Create a new instance

参数:

eventType - The type of events to match

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

方法详细资料

acceptEvent

protected boolean acceptEvent(java.lang.Object evt)
                       throws java.lang.Exception

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

抛出:

java.lang.Exception

userEventTriggered

public final void userEventTriggered(ChannelHandlerContext ctx,
                                     java.lang.Object evt)
                              throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

userEventTriggered 在接口中 ChannelInboundHandler

覆盖:

userEventTriggered 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

eventReceived

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

Is called for each user event triggered of type I.

参数:

ctx - the ChannelHandlerContext which this SimpleUserEventChannelHandler belongs to

evt - the user event to handle

抛出:

java.lang.Exception - is thrown if an error occurred