io.netty.handler.codec.protobuf

Class ProtobufVarint32LengthFieldPrepender

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

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

io.netty.handler.codec.protobuf.ProtobufVarint32LengthFieldPrepender

All Implemented Interfaces:

ChannelHandler, ChannelOperationHandler, ChannelOutboundHandler, ChannelOutboundMessageHandler<ByteBuf>

@ChannelHandler.Sharable
public class ProtobufVarint32LengthFieldPrepender
extends MessageToByteEncoder<ByteBuf>

An encoder that prepends the the Google Protocol Buffers Base 128 Varints integer length field. For example:

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

*

See Also:

CodedOutputStream

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ProtobufVarint32LengthFieldPrepender() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(ChannelHandlerContext ctx, ByteBuf msg, ByteBuf out)
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this encoder.

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

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, bind, close, connect, deregister, disconnect, 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.ChannelOperationHandler

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

ProtobufVarint32LengthFieldPrepender

public ProtobufVarint32LengthFieldPrepender()

Creates a new instance.

Method Detail

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Description copied from class: MessageToByteEncoder

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

Overrides:

isEncodable in class MessageToByteEncoder<ByteBuf>

Parameters:

msg - the message

Throws:

Exception

encode

public void encode(ChannelHandlerContext ctx,
          ByteBuf msg,
          ByteBuf out)
            throws Exception

Specified by:

encode in class MessageToByteEncoder<ByteBuf>

Throws:

Exception