io.netty.handler.codec

Class MessageToMessageCodec<INBOUND_IN,INBOUND_OUT,OUTBOUND_IN,OUTBOUND_OUT>

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelHandlerAdapter

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

All Implemented Interfaces:

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

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

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<?>[] acceptedInboundMsgTypes, Class<?>[] acceptedOutboundMsgTypes)

Method Summary

Methods

Modifier and Type	Method and Description
abstract INBOUND_OUT	decode(io.netty.channel.ChannelHandlerContext ctx, INBOUND_IN msg)
abstract OUTBOUND_OUT	encode(io.netty.channel.ChannelHandlerContext ctx, OUTBOUND_IN msg)
void	flush(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelFuture future)
void	inboundBufferUpdated(io.netty.channel.ChannelHandlerContext ctx)
boolean	isDecodable(Object msg) Returns true if and only if the specified message can be decoded by this codec.
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this codec.
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.ChannelHandlerAdapter

bind, close, connect, deregister, disconnect

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, channelActive, channelInactive, channelRegistered, channelUnregistered, 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, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelOperationHandler

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

MessageToMessageCodec

protected MessageToMessageCodec()

MessageToMessageCodec

protected MessageToMessageCodec(Class<?>[] acceptedInboundMsgTypes,
                     Class<?>[] acceptedOutboundMsgTypes)

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

Specified by:

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

Throws:

Exception

inboundBufferUpdated

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

Specified by:

inboundBufferUpdated in interface io.netty.channel.ChannelStateHandler

Overrides:

inboundBufferUpdated in class io.netty.channel.ChannelStateHandlerAdapter

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

Specified by:

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

Throws:

Exception

flush

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

Specified by:

flush in interface io.netty.channel.ChannelOperationHandler

Overrides:

flush in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

isDecodable

public boolean isDecodable(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

isEncodable

public boolean isEncodable(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

public abstract OUTBOUND_OUT encode(io.netty.channel.ChannelHandlerContext ctx,
                  OUTBOUND_IN msg)
                             throws Exception

Throws:

Exception

decode

public abstract INBOUND_OUT decode(io.netty.channel.ChannelHandlerContext ctx,
                 INBOUND_IN msg)
                            throws Exception

Throws:

Exception