io.netty.handler.codec.protobuf

Class ProtobufVarint32FrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundByteHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.protobuf.ProtobufVarint32FrameDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelStateHandler

public class ProtobufVarint32FrameDecoder
extends ByteToMessageDecoder

A decoder that splits the received ByteBufs dynamically by the value of the Google Protocol Buffers Base 128 Varints integer length field in the message. For example:

 BEFORE DECODE (302 bytes)       AFTER DECODE (300 bytes)
 +--------+---------------+      +---------------+
 | Length | Protobuf Data |----->| Protobuf Data |
 | 0xAC02 |  (300 bytes)  |      |  (300 bytes)  |
 +--------+---------------+      +---------------+
 

See Also:

CodedInputStream

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ProtobufVarint32FrameDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in) Decode the from one ByteBuf to an other.

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

callDecode, channelInactive, channelReadSuspended, decodeLast, inboundBufferUpdated, isSingleDecode, setSingleDecode

Methods inherited from class io.netty.channel.ChannelInboundByteHandlerAdapter

discardInboundReadBytes, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

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.ChannelStateHandler

channelActive, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

ProtobufVarint32FrameDecoder

public ProtobufVarint32FrameDecoder()

Method Detail

decode

protected Object decode(io.netty.channel.ChannelHandlerContext ctx,
            io.netty.buffer.ByteBuf in)
                 throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read anymore, till nothing was read from the input ByteBuf or till this method returns null.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToByteDecoder belongs to

in - the ByteBuf from which to read data

Returns:

message the message to which the content of the ByteBuf was decoded, or null if there was not enough data left in the ByteBuf to decode.

Throws:

Exception - is thrown if an error accour