io.netty.handler.codec.protobuf

Class ProtobufVarint32LengthFieldPrepender

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

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

io.netty.handler.codec.protobuf.ProtobufVarint32LengthFieldPrepender

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleOutboundMessageHandler<io.netty.buffer.ByteBuf>, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundMessageHandler<io.netty.buffer.ByteBuf>

@ChannelHandler.Sharable
public class ProtobufVarint32LengthFieldPrepender
extends MessageToByteEncoder<io.netty.buffer.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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
ProtobufVarint32LengthFieldPrepender()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf msg, io.netty.buffer.ByteBuf out) Encode a message into a ByteBuf.

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

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

acceptOutboundMessage, beginFlush, endFlush, flush, freeOutboundBuffer, isCloseOnFailedFlush, newOutboundBuffer, setCloseOnFailedFlush

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

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, read, sendFile

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

Constructor Detail

ProtobufVarint32LengthFieldPrepender

public ProtobufVarint32LengthFieldPrepender()

Method Detail

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf msg,
          io.netty.buffer.ByteBuf out)
               throws Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called till the MessageBuf has nothing left.

Specified by:

encode in class MessageToByteEncoder<io.netty.buffer.ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error accour