io.netty.handler.codec

Class ByteToMessageCodec<I>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.ByteToMessageCodec<I>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public abstract class ByteToMessageCodec<I>
extends io.netty.channel.ChannelDuplexHandler

A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa. This can be thought of as a combination of ByteToMessageDecoder and MessageToByteEncoder. Be aware that sub-classes of ByteToMessageCodec MUST NOT annotated with @Sharable.

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	ByteToMessageCodec()
protected	ByteToMessageCodec(Class<? extends I> outboundMessageType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(Object msg)
protected abstract void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.channel.MessageList<Object> out)
protected void	decodeLast(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.channel.MessageList<Object> out)
protected abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, I msg, io.netty.buffer.ByteBuf out)
void	messageReceived(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.MessageList<Object> msgs)
void	write(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.MessageList<Object> msgs, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, read

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

ByteToMessageCodec

protected ByteToMessageCodec()

ByteToMessageCodec

protected ByteToMessageCodec(Class<? extends I> outboundMessageType)

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Throws:

Exception

messageReceived

public void messageReceived(io.netty.channel.ChannelHandlerContext ctx,
                   io.netty.channel.MessageList<Object> msgs)
                     throws Exception

Specified by:

messageReceived in interface io.netty.channel.ChannelInboundHandler

Overrides:

messageReceived in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.MessageList<Object> msgs,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

encode

protected abstract void encode(io.netty.channel.ChannelHandlerContext ctx,
          I msg,
          io.netty.buffer.ByteBuf out)
                        throws Exception

Throws:

Exception

decode

protected abstract void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          io.netty.channel.MessageList<Object> out)
                        throws Exception

Throws:

Exception

decodeLast

protected void decodeLast(io.netty.channel.ChannelHandlerContext ctx,
              io.netty.buffer.ByteBuf in,
              io.netty.channel.MessageList<Object> out)
                   throws Exception

Throws:

Exception