io.netty.channel

类 SimpleChannelInboundHandler<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<I>

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

直接已知子类:

ByteEchoClientHandler, ByteEchoPeerHandler, DiscardClientHandler, DiscardServerHandler, FactorialClientHandler, FactorialServerHandler, FileServerHandler, HttpResponseClientHandler, HttpSnoopClientHandler, HttpSnoopServerHandler, HttpStaticFileServerHandler, HttpUploadClientHandler, HttpUploadServerHandler, LocalEchoClientHandler, MsgEchoClientHandler, MsgEchoPeerHandler, OkResponseHandler, QuoteOfTheMomentClientHandler, QuoteOfTheMomentServerHandler, RxtxClientHandler, SecureChatClientHandler, SecureChatServerHandler, SocksServerConnectHandler, SocksServerHandler, SpdyServerHandler, TelnetClientHandler, TelnetServerHandler, UptimeClientHandler, UptimeServerHandler, WebSocketClientHandler, WebSocketFrameHandler, WebSocketIndexPageHandler, WebSocketServerHandler, WorldClockClientHandler, WorldClockServerHandler

public abstract class SimpleChannelInboundHandler<I>
extends ChannelInboundHandlerAdapter

ChannelInboundHandlerAdapter which allows to explicit only handle a specific type of messages. For example here is an implementation which only handle String messages.

     public class StringHandler extends
             SimpleChannelInboundHandler<String> {

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

Be aware that depending of the constructor parameters it will release all handled messages 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.

Forward compatibility notice

Please keep in mind that #channelRead0(ChannelHandlerContext, I) will be renamed to messageReceived(ChannelHandlerContext, I) in 5.0.

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

限定符	构造器和说明
protected	SimpleChannelInboundHandler() see SimpleChannelInboundHandler(boolean) with true as boolean parameter.
protected	SimpleChannelInboundHandler(boolean autoRelease) Create a new instance which will try to detect the types to match out of the type parameter of the class.
protected	SimpleChannelInboundHandler(java.lang.Class<? extends I> inboundMessageType) see SimpleChannelInboundHandler(Class, boolean) with true as boolean value.
protected	SimpleChannelInboundHandler(java.lang.Class<? extends I> inboundMessageType, boolean autoRelease) Create a new instance

方法概要

方法

限定符和类型	方法和说明
boolean	acceptInboundMessage(java.lang.Object msg) Returns true if the given message should be handled.
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected abstract void	channelRead0(ChannelHandlerContext ctx, I msg) Please keep in mind that this method will be renamed to messageReceived(ChannelHandlerContext, I) in 5.0.

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

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

从类继承的方法 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

构造器详细资料

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler()

see SimpleChannelInboundHandler(boolean) with true as boolean parameter.

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler(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 messages should be released automatically by passing them to ReferenceCountUtil.release(Object).

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler(java.lang.Class<? extends I> inboundMessageType)

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

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler(java.lang.Class<? extends I> inboundMessageType,
                           boolean autoRelease)

Create a new instance

参数:

inboundMessageType - The type of messages to match

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

方法详细资料

acceptInboundMessage

public boolean acceptInboundMessage(java.lang.Object msg)
                             throws java.lang.Exception

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

抛出:

java.lang.Exception

channelRead

public void channelRead(ChannelHandlerContext ctx,
               java.lang.Object msg)
                 throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelRead 在接口中 ChannelInboundHandler

覆盖:

channelRead 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelRead0

protected abstract void channelRead0(ChannelHandlerContext ctx,
                I msg)
                              throws java.lang.Exception

Please keep in mind that this method will be renamed to messageReceived(ChannelHandlerContext, I) in 5.0. Is called for each message of type I.

参数:

ctx - the ChannelHandlerContext which this SimpleChannelInboundHandler belongs to

msg - the message to handle

抛出:

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