io.netty.handler.codec.bytes

public Class ByteArrayDecoder

Class Inheritance

extends MessageToMessageDecoder<ByteBuf>

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.MessageToMessageDecoder
io.netty.handler.codec.bytes.ByteArrayDecoder

Imports

io.netty.buffer.ByteBuf, .ByteBufUtil, io.netty.channel.ChannelHandlerContext, .ChannelPipeline, io.netty.handler.codec.LengthFieldBasedFrameDecoder, .LengthFieldPrepender, .MessageToMessageDecoder, java.util.List

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 channelRead(ChannelHandlerContext ctx, byte[] bytes) {
    ...
}

Constructor Summary

Access	Constructor and Description
public	ByteArrayDecoder()

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, ByteBuf the message to decode to an other one msg, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other.

Inherited from io.netty.handler.codec.MessageToMessageDecoder:: acceptInboundMessage channelRead

Constructor Detail

ByteArrayDecoder	back to summary
public ByteArrayDecoder()

Method Detail

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Doc from io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other. This method will be called for each written message that can be handled by this decoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:ByteBuf the message to decode to an other one out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode.

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:ByteBuf: the message to decode to an other one
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs