io.netty.handler.codec.bytes

Class ByteArrayDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToMessageDecoder<io.netty.buffer.ByteBuf>

io.netty.handler.codec.bytes.ByteArrayDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundMessageHandler<io.netty.buffer.ByteBuf>, io.netty.channel.ChannelStateHandler

public class ByteArrayDecoder
extends MessageToMessageDecoder<io.netty.buffer.ByteBuf>

Decodes a received ByteBuf into an array of bytes. A typical setup for TCP/IP would be:

 ChannelPipeline pipeline = ...;

 // Decoders
 pipeline.addLast("frameDecoder",
                  new LengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4));
 pipeline.addLast("bytesDecoder",
                  new ByteArrayDecoder());

 // Encoder
 pipeline.addLast("frameEncoder", new LengthFieldPrepender(4));
 pipeline.addLast("bytesEncoder", new ByteArrayEncoder());
 

and then you can use an array of bytes instead of a ByteBuf as a message:

 void messageReceived(ChannelHandlerContext ctx, byte[] bytes) {
     ...
 }
 

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
ByteArrayDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf msg) Decode from one message to an other.

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

messageReceived

Methods inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

acceptInboundMessage, beginMessageReceived, endMessageReceived, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

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

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

ByteArrayDecoder

public ByteArrayDecoder()

Method Detail

decode

protected Object decode(io.netty.channel.ChannelHandlerContext ctx,
            io.netty.buffer.ByteBuf msg)
                 throws Exception

Description copied from class: MessageToMessageDecoder

Decode from one message to an other. This method will be called till either the MessageBuf has nothing left or till this method returns null.

Specified by:

decode in class MessageToMessageDecoder<io.netty.buffer.ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

Returns:

message the decoded message or null if more messages are needed be cause the implementation needs to do some kind of aggragation

Throws:

Exception - is thrown if an error accour