io.netty.channel

Class SimpleChannelInboundHandler<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<I>

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public abstract class SimpleChannelInboundHandler<I>
extends ChannelInboundHandlerAdapter

ChannelInboundHandlerAdapter which allows to explicit only handle a specific type of messages. For example here is an implementation which only handle String messages.

     public class StringHandler extends
             SimpleChannelInboundHandler<String> {

         @Override
         public void messageReceived(ChannelHandlerContext ctx, String message)
                 throws Exception {
             System.out.println(message);
         }
     }
 

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleChannelInboundHandler()
protected	SimpleChannelInboundHandler(boolean autoRelease)
protected	SimpleChannelInboundHandler(Class<? extends I> inboundMessageType)
protected	SimpleChannelInboundHandler(Class<? extends I> inboundMessageType, boolean autoRelease)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptInboundMessage(Object msg)
protected void	beginMessageReceived(ChannelHandlerContext ctx) Is called before the first messageReceived(ChannelHandlerContext, Object) of the current MessageList is handled.
protected void	endMessageReceived(ChannelHandlerContext ctx) Is called after the last messageReceived(ChannelHandlerContext, Object) of the current MessageList is handled.
protected abstract void	messageReceived(ChannelHandlerContext ctx, I msg) Is called for each message of type I.
void	messageReceived(ChannelHandlerContext ctx, MessageList<Object> msgs) Calls ChannelHandlerContext.fireMessageReceived(MessageList) to forward to the next ChannelInboundHandler in the ChannelPipeline.

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

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler()

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler(boolean autoRelease)

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler(Class<? extends I> inboundMessageType)

SimpleChannelInboundHandler

protected SimpleChannelInboundHandler(Class<? extends I> inboundMessageType,
                           boolean autoRelease)

Method Detail

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)
                             throws Exception

Throws:

Exception

messageReceived

public void messageReceived(ChannelHandlerContext ctx,
                   MessageList<Object> msgs)
                     throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireMessageReceived(MessageList) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

messageReceived in interface ChannelInboundHandler

Overrides:

messageReceived in class ChannelInboundHandlerAdapter

Throws:

Exception

messageReceived

protected abstract void messageReceived(ChannelHandlerContext ctx,
                   I msg)
                                 throws Exception

Is called for each message of type I.

Parameters:

ctx - the ChannelHandlerContext which this SimpleChannelInboundHandler belongs to

msg - the message to handle

Throws:

Exception - is thrown if an error accour

beginMessageReceived

protected void beginMessageReceived(ChannelHandlerContext ctx)
                             throws Exception

Is called before the first messageReceived(ChannelHandlerContext, Object) of the current MessageList is handled.

Parameters:

ctx - the ChannelHandlerContext which is bound to this handler

Throws:

Exception

endMessageReceived

protected void endMessageReceived(ChannelHandlerContext ctx)
                           throws Exception

Is called after the last messageReceived(ChannelHandlerContext, Object) of the current MessageList is handled.

Parameters:

ctx - the ChannelHandlerContext which is bound to this handler

Throws:

Exception