io.netty.handler.codec

类 ByteToMessageCodec<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.ByteToMessageCodec<I>

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public abstract class ByteToMessageCodec<I>
extends ChannelDuplexHandler

A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa. This can be thought of as a combination of ByteToMessageDecoder and MessageToByteEncoder. Be aware that sub-classes of ByteToMessageCodec MUST NOT annotated with @Sharable.

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
boolean	acceptOutboundMessage(java.lang.Object msg) Returns true if and only if the specified message can be encoded by this codec.
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected abstract void	decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
protected abstract void	encode(ChannelHandlerContext ctx, I msg, ByteBuf out)
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

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

bind, close, connect, deregister, disconnect, flush, read

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

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

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

ensureNotSharable, isSharable

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

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

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

exceptionCaught

构造器详细资料

ByteToMessageCodec

protected ByteToMessageCodec()

see ByteToMessageCodec(boolean) with true as boolean parameter.

ByteToMessageCodec

protected ByteToMessageCodec(java.lang.Class<? extends I> outboundMessageType)

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

ByteToMessageCodec

protected ByteToMessageCodec(boolean preferDirect)

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

参数:

preferDirect - true if a direct ByteBuf should be tried to be used as target for the encoded messages. If false is used it will allocate a heap ByteBuf, which is backed by an byte array.

ByteToMessageCodec

protected ByteToMessageCodec(java.lang.Class<? extends I> outboundMessageType,
                  boolean preferDirect)

Create a new instance

参数:

outboundMessageType - The type of messages to match

preferDirect - true if a direct ByteBuf should be tried to be used as target for the encoded messages. If false is used it will allocate a heap ByteBuf, which is backed by an byte array.

方法详细资料

acceptOutboundMessage

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

Returns true if and only if the specified message can be encoded by this codec.

参数:

msg - the message

抛出:

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

write

public void write(ChannelHandlerContext ctx,
         java.lang.Object msg,
         ChannelPromise promise)
           throws java.lang.Exception

从类复制的说明: ChannelDuplexHandler

Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelReadComplete 在接口中 ChannelInboundHandler

覆盖:

channelReadComplete 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelInactive 在接口中 ChannelInboundHandler

覆盖:

channelInactive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

encode

protected abstract void encode(ChannelHandlerContext ctx,
          I msg,
          ByteBuf out)
                        throws java.lang.Exception

抛出:

java.lang.Exception

另请参阅:

MessageToByteEncoder.encode(ChannelHandlerContext, Object, ByteBuf)

decode

protected abstract void decode(ChannelHandlerContext ctx,
          ByteBuf in,
          java.util.List<java.lang.Object> out)
                        throws java.lang.Exception

抛出:

java.lang.Exception

另请参阅:

ByteToMessageDecoder.decode(ChannelHandlerContext, ByteBuf, List)

decodeLast

protected void decodeLast(ChannelHandlerContext ctx,
              ByteBuf in,
              java.util.List<java.lang.Object> out)
                   throws java.lang.Exception

抛出:

java.lang.Exception

另请参阅:

ByteToMessageDecoder.decodeLast(ChannelHandlerContext, ByteBuf, List)