io.netty.handler.codec

Class MessageToMessageDecoder<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToMessageDecoder<I>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleInboundMessageHandler<I>, io.netty.channel.ChannelInboundMessageHandler<I>, io.netty.channel.ChannelStateHandler

Direct Known Subclasses:

Base64Decoder, ByteArrayDecoder, ProtobufDecoder, StringDecoder

public abstract class MessageToMessageDecoder<I>
extends io.netty.channel.ChannelInboundMessageHandlerAdapter<I>

ChannelInboundMessageHandler which decodes from one message to an other message For example here is an implementation which decodes a String to an Integer which represent the length of the String.

     public class StringToIntegerDecoder extends
             MessageToMessageDecoder<String> {

         @Override
         public void decode(ChannelHandlerContext ctx, String message,
                 MessageBuf out) throws Exception {
             out.add(message.length());
         }
     }
 

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

ABORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageToMessageDecoder()
protected	MessageToMessageDecoder(Class<? extends I> inboundMessageType)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	decode(io.netty.channel.ChannelHandlerContext ctx, I msg, io.netty.buffer.MessageBuf<Object> out) Decode from one message to an other.
void	messageReceived(io.netty.channel.ChannelHandlerContext ctx, I msg)

Methods inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

acceptInboundMessage, beginMessageReceived, endMessageReceived, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

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

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

MessageToMessageDecoder

protected MessageToMessageDecoder()

MessageToMessageDecoder

protected MessageToMessageDecoder(Class<? extends I> inboundMessageType)

Method Detail

messageReceived

public final void messageReceived(io.netty.channel.ChannelHandlerContext ctx,
                   I msg)
                           throws Exception

Throws:

Exception

decode

protected abstract void decode(io.netty.channel.ChannelHandlerContext ctx,
          I msg,
          io.netty.buffer.MessageBuf<Object> out)
                        throws Exception

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

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the MessageBuf to which decoded messages should be added

Throws:

Exception - is thrown if an error accour