io.netty.handler.codec

Class MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelDuplexHandler

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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundMessageHandler<INBOUND_IN>, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundMessageHandler<OUTBOUND_IN>, io.netty.channel.ChannelStateHandler

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

A Codec for on-the-fly encoding/decoding of message. This can be though of an 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();
         }
     }
 

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()

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 Object	decode(io.netty.channel.ChannelHandlerContext ctx, INBOUND_IN msg)
protected abstract Object	encode(io.netty.channel.ChannelHandlerContext ctx, OUTBOUND_IN msg)
void	flush(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise future)
void	freeInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
void	freeOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
void	inboundBufferUpdated(io.netty.channel.ChannelHandlerContext ctx)
io.netty.buffer.MessageBuf<INBOUND_IN>	newInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
io.netty.buffer.MessageBuf<OUTBOUND_IN>	newOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

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

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, 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.ChannelStateHandler

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered

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, userEventTriggered

Constructor Detail

MessageToMessageCodec

protected MessageToMessageCodec()

Method Detail

newInboundBuffer

public io.netty.buffer.MessageBuf<INBOUND_IN> newInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                                                        throws Exception

Specified by:

newInboundBuffer in interface io.netty.channel.ChannelInboundMessageHandler<INBOUND_IN>

Throws:

Exception

freeInboundBuffer

public void freeInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                       throws Exception

Throws:

Exception

newOutboundBuffer

public io.netty.buffer.MessageBuf<OUTBOUND_IN> newOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                                                          throws Exception

Specified by:

newOutboundBuffer in interface io.netty.channel.ChannelOutboundMessageHandler<OUTBOUND_IN>

Throws:

Exception

freeOutboundBuffer

public void freeOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

Throws:

Exception

inboundBufferUpdated

public void inboundBufferUpdated(io.netty.channel.ChannelHandlerContext ctx)
                          throws Exception

Specified by:

inboundBufferUpdated in interface io.netty.channel.ChannelStateHandler

Throws:

Exception

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.ChannelPromise future)
           throws Exception

Specified by:

flush in interface io.netty.channel.ChannelOperationHandler

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 Object encode(io.netty.channel.ChannelHandlerContext ctx,
            OUTBOUND_IN msg)
                          throws Exception

Throws:

Exception

decode

protected abstract Object decode(io.netty.channel.ChannelHandlerContext ctx,
            INBOUND_IN msg)
                          throws Exception

Throws:

Exception