ProtobufDecoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.MessageToMessageDecoder<ByteBuf>
    - - io.netty.handler.codec.protobuf.ProtobufDecoder

All Implemented Interfaces:: ChannelHandler ， ChannelInboundHandler

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

将收到的ByteBuf解码为Google Protocol Buffers Message和MessageLite 。请注意，如果您使用基于流的传输（如TCP / IP），则必须将此解码器与ByteToMessageDecoder（例如ProtobufVarint32FrameDecoder或LengthFieldBasedFrameDecoder）一起使用。 TCP / IP的典型设置是：

  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());

然后您可以使用MyMessage而不是ByteBuf作为消息：

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

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`ProtobufDecoder(MessageLite prototype)` 创建一个新的实例。
`ProtobufDecoder(MessageLite prototype, ExtensionRegistry extensionRegistry)`
`ProtobufDecoder(MessageLite prototype, ExtensionRegistryLite extensionRegistry)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected void`	`decode(ChannelHandlerContext ctx, ByteBuf msg, java.util.List<java.lang.Object> out)` 从一条消息解码到另一条消息。

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder
acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler
handlerAdded, handlerRemoved

构造方法详细信息

ProtobufDecoder

public ProtobufDecoder(MessageLite prototype)

创建一个新的实例。

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
  
  从一条消息解码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
  
  Specified by:
  
  decode在课堂上 MessageToMessageDecoder<ByteBuf>
  
  参数
  
  ctx - 这MessageToMessageDecoder属于的ChannelHandlerContext
  
  msg - 解码到另一个的消息
  
  out - 应该添加解码消息的 List
  
  异常
  
  java.lang.Exception - 发生错误时抛出

Class ProtobufDecoder

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

ProtobufDecoder

ProtobufDecoder

ProtobufDecoder

方法详细信息

decode