io.netty.handler.codec

Class ByteToByteCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.ByteToByteCodec

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundByteHandler, io.netty.channel.ChannelStateHandler

public abstract class ByteToByteCodec
extends io.netty.channel.ChannelDuplexHandler
implements io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelOutboundByteHandler

A Codec for on-the-fly encoding/decoding of bytes. This can be thought of as a combination of ByteToByteDecoder and ByteToByteEncoder. Here is an example of a ByteToByteCodec which just square Integer read from a ByteBuf.

     public class SquareCodec extends ByteToByteCodec {
         @Override
         public void decode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out)
                 throws Exception {
             if (in.readableBytes() < 4) {
                 return;
             }
             int value = in.readInt();
             out.writeInt(value * value);
         }

         @Overrride
         public void encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out)
                 throws Exception {
             if (in.readableBytes() < 4) {
                 return;
             }
             int value = in.readInt();
             out.writeInt(value / value);
         }
     }
 

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ByteToByteCodec()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.ByteBuf out)
protected void	decodeLast(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.ByteBuf out)
void	discardInboundReadBytes(io.netty.channel.ChannelHandlerContext ctx)
void	discardOutboundReadBytes(io.netty.channel.ChannelHandlerContext ctx)
protected abstract void	encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.ByteBuf out)
void	flush(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	freeInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
void	freeOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
void	inboundBufferUpdated(io.netty.channel.ChannelHandlerContext ctx)
io.netty.buffer.ByteBuf	newInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
io.netty.buffer.ByteBuf	newOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

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, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelOperationHandler

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

Constructor Detail

ByteToByteCodec

public ByteToByteCodec()

Method Detail

newInboundBuffer

public io.netty.buffer.ByteBuf newInboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                                         throws Exception

Specified by:

newInboundBuffer in interface io.netty.channel.ChannelInboundByteHandler

Throws:

Exception

inboundBufferUpdated

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

Specified by:

inboundBufferUpdated in interface io.netty.channel.ChannelStateHandler

Throws:

Exception

newOutboundBuffer

public io.netty.buffer.ByteBuf newOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                                          throws Exception

Specified by:

newOutboundBuffer in interface io.netty.channel.ChannelOutboundByteHandler

Throws:

Exception

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

flush in interface io.netty.channel.ChannelOperationHandler

Throws:

Exception

discardInboundReadBytes

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

Specified by:

discardInboundReadBytes in interface io.netty.channel.ChannelInboundByteHandler

Throws:

Exception

discardOutboundReadBytes

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

Specified by:

discardOutboundReadBytes in interface io.netty.channel.ChannelOutboundByteHandler

Throws:

Exception

freeInboundBuffer

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

Throws:

Exception

freeOutboundBuffer

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

Throws:

Exception

encode

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

Throws:

Exception

See Also:

ByteToByteEncoder#encode(ChannelHandlerContext, ByteBuf, ByteBuf)}

decode

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

Throws:

Exception

See Also:

ByteToByteDecoder#decode(ChannelHandlerContext, ByteBuf, ByteBuf)}

decodeLast

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

Throws:

Exception

See Also:

ByteToByteDecoder#decodeLast(ChannelHandlerContext, ByteBuf, ByteBuf)}