io.netty.handler.codec.protobuf

Class ProtobufEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToMessageEncoder<com.google.protobuf.MessageLiteOrBuilder>

io.netty.handler.codec.protobuf.ProtobufEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleOutboundMessageHandler<com.google.protobuf.MessageLiteOrBuilder>, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundMessageHandler<com.google.protobuf.MessageLiteOrBuilder>

@ChannelHandler.Sharable
public class ProtobufEncoder
extends MessageToMessageEncoder<com.google.protobuf.MessageLiteOrBuilder>

Encodes the requested Google Protocol Buffers Message and MessageLite into a ByteBuf. 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 messageReceived(ChannelHandlerContext ctx, MyMessage req) {
     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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
ProtobufEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, com.google.protobuf.MessageLiteOrBuilder msg, io.netty.buffer.MessageBuf<Object> out) Encode from one message to an other.

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

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

acceptOutboundMessage, beginFlush, endFlush, flush, 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

exceptionCaught, handlerAdded, handlerRemoved

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

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

ProtobufEncoder

public ProtobufEncoder()

Method Detail

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
          com.google.protobuf.MessageLiteOrBuilder msg,
          io.netty.buffer.MessageBuf<Object> out)
               throws Exception

Description copied from class: MessageToMessageEncoder

Encode from one message to an other. This method will be called till either the MessageBuf has nothing left or till this method returns null.

Specified by:

encode in class MessageToMessageEncoder<com.google.protobuf.MessageLiteOrBuilder>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the MessageBuf into which the encoded msg should be added needs to do some kind of aggragation

Throws:

Exception - is thrown if an error accour