java.lang.Object
- io.netty5.channel.SimpleChannelInboundHandler<I>

All Implemented Interfaces:: ChannelHandler

public abstract class SimpleChannelInboundHandler<I>
extends Object
implements ChannelHandler

ChannelHandler 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
         protected void messageReceived(ChannelHandlerContext ctx, String message)
                 throws Exception {
             System.out.println(message);
         }
     }

Be aware that depending of the constructor parameters it will release all handled messages by passing them to Resource.dispose(Object).

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`SimpleChannelInboundHandler()`	see `SimpleChannelInboundHandler(boolean)` with `true` as boolean parameter.
`protected`	`SimpleChannelInboundHandler(boolean autoRelease)`	Create a new instance which will try to detect the types to match out of the type parameter of the class.
`protected`	`SimpleChannelInboundHandler(Class<? extends I> inboundMessageType)`	see `SimpleChannelInboundHandler(Class, boolean)` with `true` as boolean value.
`protected`	`SimpleChannelInboundHandler(Class<? extends I> inboundMessageType, boolean autoRelease)`	Create a new instance

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`acceptInboundMessage(Object msg)`	Returns `true` if the given message should be handled.
`void`	`channelRead(ChannelHandlerContext ctx, Object msg)`	Invoked when the current `Channel` has read a message from the peer.
`protected abstract void`	`messageReceived(ChannelHandlerContext ctx, I msg)`	Is called for each message of type `SimpleChannelInboundHandler`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty5.channel.ChannelHandler
bind, channelActive, channelExceptionCaught, channelInactive, channelInboundEvent, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

- Constructor Detail
  - SimpleChannelInboundHandler
```
protected SimpleChannelInboundHandler()
```
    see SimpleChannelInboundHandler(boolean) with true as boolean parameter.
  - SimpleChannelInboundHandler
```
protected SimpleChannelInboundHandler(boolean autoRelease)
```
    Create a new instance which will try to detect the types to match out of the type parameter of the class.
    
    Parameters:
    
    autoRelease - true if handled messages should be released automatically by passing them to Resource.dispose(Object).
  - SimpleChannelInboundHandler
```
protected SimpleChannelInboundHandler(Class<? extends I> inboundMessageType)
```
    see SimpleChannelInboundHandler(Class, boolean) with true as boolean value.
  - SimpleChannelInboundHandler
```
protected SimpleChannelInboundHandler(Class<? extends I> inboundMessageType,
                                      boolean autoRelease)
```
    Create a new instance
    
    Parameters:
    
    inboundMessageType - The type of messages to match
    
    autoRelease - true if handled messages should be released automatically by passing them to Resource.dispose(Object).
- Method Detail
  - acceptInboundMessage
```
public boolean acceptInboundMessage(Object msg)
                             throws Exception
```
    Returns true if the given message should be handled. If false it will be passed to the next ChannelHandler in the ChannelPipeline.
    
    Throws:
    
    Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception
```
    Description copied from interface: ChannelHandler
    
    Invoked when the current Channel has read a message from the peer.
    
    Specified by:
    
    channelRead in interface ChannelHandler
    
    Throws:
    
    Exception
  - messageReceived
```
protected abstract void messageReceived(ChannelHandlerContext ctx,
                                        I msg)
                                 throws Exception
```
    Is called for each message of type SimpleChannelInboundHandler.
    
    Parameters:
    
    ctx - the ChannelHandlerContext which this SimpleChannelInboundHandler belongs to
    
    msg - the message to handle
    
    Throws:
    
    Exception - is thrown if an error occurred

Class SimpleChannelInboundHandler<I>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty5.channel.ChannelHandler

Constructor Detail

SimpleChannelInboundHandler

SimpleChannelInboundHandler

SimpleChannelInboundHandler

SimpleChannelInboundHandler

Method Detail

acceptInboundMessage

channelRead

messageReceived