io.netty.handler.codec.bytes

Class ByteArrayDecoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<io.netty.buffer.ByteBuf,byte[]>

io.netty.handler.codec.bytes.ByteArrayDecoder

All Implemented Interfaces:

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

public class ByteArrayDecoder
extends MessageToMessageDecoder<io.netty.buffer.ByteBuf,byte[]>

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, MessageEvent e) {
     byte[] bytes = (byte[]) e.getMessage();
     ...
 }
 

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ByteArrayDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf msg)
boolean	isDecodable(Object msg) Returns true if and only if the specified message can be decoded by this decoder.

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

inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, channelActive, channelInactive, channelRegistered, channelUnregistered, 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, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

ByteArrayDecoder

public ByteArrayDecoder()

Method Detail

isDecodable

public boolean isDecodable(Object msg)
                    throws Exception

Description copied from class: MessageToMessageDecoder

Returns true if and only if the specified message can be decoded by this decoder.

Overrides:

isDecodable in class MessageToMessageDecoder<io.netty.buffer.ByteBuf,byte[]>

Parameters:

msg - the message

Throws:

Exception

decode

public byte[] decode(io.netty.channel.ChannelHandlerContext ctx,
            io.netty.buffer.ByteBuf msg)
              throws Exception

Specified by:

decode in class MessageToMessageDecoder<io.netty.buffer.ByteBuf,byte[]>

Throws:

Exception