io.netty.handler.codec.protobuf

类 ProtobufDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<ByteBuf>

io.netty.handler.codec.protobuf.ProtobufDecoder

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

@ChannelHandler.Sharable
public class ProtobufDecoder
extends MessageToMessageDecoder<ByteBuf>

Decodes a received ByteBuf into a Google Protocol Buffers Message and MessageLite. Please note that this decoder must be used with a proper ByteToMessageDecoder such as ProtobufVarint32FrameDecoder or LengthFieldBasedFrameDecoder if you are using a stream-based transport such as TCP/IP. A typical setup for TCP/IP would be:

 ChannelPipeline pipeline = ...;

 // Decoders
 pipeline.addLast("frameDecoder",
                  new LengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4));
 pipeline.addLast("protobufDecoder",
                  new ProtobufDecoder(MyMessage.getDefaultInstance()));

 // Encoder
 pipeline.addLast("frameEncoder", new LengthFieldPrepender(4));
 pipeline.addLast("protobufEncoder", new ProtobufEncoder());
 

and then you can use a MyMessage instead of a ByteBuf as a message:

 void channelRead(ChannelHandlerContext ctx, Object msg) {
     MyMessage req = (MyMessage) msg;
     MyMessage res = MyMessage.newBuilder().setText(
                               "Did you say '" + req.getText() + "'?").build();
     ch.write(res);
 }
 

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
ProtobufDecoder(MessageLite prototype) Creates a new instance.
ProtobufDecoder(MessageLite prototype, ExtensionRegistry extensionRegistry)
ProtobufDecoder(MessageLite prototype, ExtensionRegistryLite extensionRegistry)

方法概要

限定符和类型	方法和说明
protected void	decode(ChannelHandlerContext ctx, ByteBuf msg, java.util.List<java.lang.Object> out) Decode from one message to an other.

从类继承的方法 io.netty.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead

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

构造器详细资料

ProtobufDecoder

public ProtobufDecoder(MessageLite prototype)

Creates a new instance.

ProtobufDecoder

public ProtobufDecoder(MessageLite prototype,
                       ExtensionRegistry extensionRegistry)

ProtobufDecoder

public ProtobufDecoder(MessageLite prototype,
                       ExtensionRegistryLite extensionRegistry)

方法详细资料

decode

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

从类复制的说明: MessageToMessageDecoder

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

指定者:

decode 在类中 MessageToMessageDecoder<ByteBuf>

参数:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the List to which decoded messages should be added

抛出:

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