io.netty.handler.codec

Class MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public abstract class MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>
extends io.netty.channel.ChannelDuplexHandler

A Codec for on-the-fly encoding/decoding of message. This can be thought of as a combination of MessageToMessageDecoder and MessageToMessageEncoder. Here is an example of a MessageToMessageCodec which just decode from Integer to Long and encode from Long to Integer.

     public class NumberCodec extends
             MessageToMessageCodec<Integer, Long, Long, Integer> {
         @Override
         public Long decode(ChannelHandlerContext ctx, Integer msg)
                 throws Exception {
             return msg.longValue();
         }

         @Overrride
         public Integer encode(ChannelHandlerContext ctx, Long msg)
                 throws Exception {
             return msg.intValue();
         }
     }
 

Be aware that you need to call ReferenceCounted.retain() on messages that are just passed through if they are of type ReferenceCounted. This is needed as the MessageToMessageCodec will call ReferenceCounted.release() on encoded / decoded messages.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageToMessageCodec()
protected	MessageToMessageCodec(Class<? extends INBOUND_IN> inboundMessageType, Class<? extends OUTBOUND_IN> outboundMessageType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptInboundMessage(Object msg) Returns true if and only if the specified message can be decoded by this codec.
boolean	acceptOutboundMessage(Object msg) Returns true if and only if the specified message can be encoded by this codec.
protected abstract void	decode(io.netty.channel.ChannelHandlerContext ctx, INBOUND_IN msg, io.netty.channel.MessageList<Object> out)
protected abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, OUTBOUND_IN msg, io.netty.channel.MessageList<Object> out)
void	messageReceived(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.MessageList<Object> msgs)
void	write(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.MessageList<Object> msgs, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, channelWritabilityChanged, 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.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

MessageToMessageCodec

protected MessageToMessageCodec()

MessageToMessageCodec

protected MessageToMessageCodec(Class<? extends INBOUND_IN> inboundMessageType,
                     Class<? extends OUTBOUND_IN> outboundMessageType)

Method Detail

messageReceived

public void messageReceived(io.netty.channel.ChannelHandlerContext ctx,
                   io.netty.channel.MessageList<Object> msgs)
                     throws Exception

Specified by:

messageReceived in interface io.netty.channel.ChannelInboundHandler

Overrides:

messageReceived in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.MessageList<Object> msgs,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)
                             throws Exception

Returns true if and only if the specified message can be decoded by this codec.

Parameters:

msg - the message

Throws:

Exception

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

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

Parameters:

msg - the message

Throws:

Exception

encode

protected abstract void encode(io.netty.channel.ChannelHandlerContext ctx,
          OUTBOUND_IN msg,
          io.netty.channel.MessageList<Object> out)
                        throws Exception

Throws:

Exception

decode

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

Throws:

Exception