io.netty.handler.codec.bytes

Class ByteArrayEncoder

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

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

io.netty.handler.codec.bytes.ByteArrayEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundHandler, io.netty.channel.ChannelOutboundMessageHandler<byte[]>

public class ByteArrayEncoder
extends MessageToMessageEncoder<byte[],io.netty.buffer.ByteBuf>

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, 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
ByteArrayEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	encode(io.netty.channel.ChannelHandlerContext ctx, byte[] msg)
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this encoder.
io.netty.buffer.MessageBuf<byte[]>	newOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)

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

flush

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, bind, close, connect, deregister, disconnect, 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.ChannelOperationHandler

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

ByteArrayEncoder

public ByteArrayEncoder()

Method Detail

newOutboundBuffer

public io.netty.buffer.MessageBuf<byte[]> newOutboundBuffer(io.netty.channel.ChannelHandlerContext ctx)
                                                     throws Exception

Specified by:

newOutboundBuffer in interface io.netty.channel.ChannelOutboundHandler

Specified by:

newOutboundBuffer in interface io.netty.channel.ChannelOutboundMessageHandler<byte[]>

Overrides:

newOutboundBuffer in class io.netty.channel.ChannelOutboundMessageHandlerAdapter<byte[]>

Throws:

Exception

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Description copied from class: MessageToMessageEncoder

Returns true if and only if the specified message can be encoded by this encoder.

Overrides:

isEncodable in class MessageToMessageEncoder<byte[],io.netty.buffer.ByteBuf>

Parameters:

msg - the message

Throws:

Exception

encode

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

Specified by:

encode in class MessageToMessageEncoder<byte[],io.netty.buffer.ByteBuf>

Throws:

Exception