All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

Direct Known Subclasses:

Base64Decoder, ByteArrayDecoder, HttpContentDecoder, HttpObjectAggregator, ProtobufDecoder, SctpInboundByteStreamHandler, SctpMessageCompletionHandler, SctpMessageToMessageDecoder, SpdyHttpDecoder, StringDecoder, WebSocketClientProtocolHandler, WebSocketFrameAggregator, WebSocketServerProtocolHandler

public abstract class MessageToMessageDecoder<I>
extends ChannelInboundHandlerAdapter 

 public class StringToIntegerDecoder extends
 MessageToMessageDecoder<String> {
  @Override
 public void decode(ChannelHandlerContext ctx, String message,
 List<Object> out) throws Exception {
 out.add(message.length());
 }
 }
 

• Nested Class Summary

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

    ChannelHandler.Sharable

• Constructor Summary

  Constructors

  Modifier	Constructor and Description
  protected	MessageToMessageDecoder () Create a new instance which will try to detect the types to match out of the type parameter of the class.
  protected	MessageToMessageDecoder (java.lang.Class<? extends I> inboundMessageType) Create a new instance

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  boolean	acceptInboundMessage (java.lang.Object msg) Returns true if the given message should be handled.
  void	channelRead (ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
  protected abstract void	decode (ChannelHandlerContext ctx, I msg, java.util.List<java.lang.Object> out) Decode from one message to an other.

  • Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

    channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

  • Methods inherited from class io.netty.channel.ChannelHandlerAdapter

    ensureNotSharable, handlerAdded, handlerRemoved, isSharable

  • 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

    handlerAdded, handlerRemoved

• Constructor Detail

  • MessageToMessageDecoder

    protected MessageToMessageDecoder()

    Create a new instance which will try to detect the types to match out of the type parameter of the class.

  • MessageToMessageDecoder

    protected MessageToMessageDecoder(java.lang.Class<? extends I> inboundMessageType)

    Create a new instance

    Parameters:

    inboundMessageType - The type of messages to match and so decode

• Method Detail

  • acceptInboundMessage

    public boolean acceptInboundMessage(java.lang.Object msg)
     throws java.lang.Exception

    Returns true if the given message should be handled. If false it will be passed to the next ChannelInboundHandler in the ChannelPipeline.

    Throws:

    java.lang.Exception

  • channelRead

    public void channelRead(ChannelHandlerContext ctx,
     java.lang.Object msg)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelRead in interface ChannelInboundHandler

    Overrides:

    channelRead in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • decode

    protected abstract void decode(ChannelHandlerContext ctx,
     I msg,
     java.util.List<java.lang.Object> out)
     throws java.lang.Exception

    Decode from one message to an other. This method will be called for each written message that can be handled by this encoder.

    Parameters:

    ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

    msg - the message to decode to an other one

    out - the List to which decoded messages should be added

    Throws:

    java.lang.Exception - is thrown if an error occurs