io.netty.handler.codec.bytes

Class ByteArrayEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<byte[]>

io.netty.handler.codec.bytes.ByteArrayEncoder

All Implemented Interfaces:

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

@ChannelHandler.Sharable
public class ByteArrayEncoder
extends MessageToMessageEncoder<byte[]>

Encodes the requested array of bytes into a ByteBuf. 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

Constructor Summary

Constructors

Constructor and Description
ByteArrayEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, byte[] msg, io.netty.channel.MessageList<Object> out) Encode from one message to an other.

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

acceptOutboundMessage, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, read

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

ByteArrayEncoder

public ByteArrayEncoder()

Method Detail

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
          byte[] msg,
          io.netty.channel.MessageList<Object> out)
               throws Exception

Description copied from class: MessageToMessageEncoder

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

Specified by:

encode in class MessageToMessageEncoder<byte[]>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the MessageList into which the encoded msg should be added needs to do some kind of aggragation

Throws:

Exception - is thrown if an error accour