Top Description Constructors Methods
io.netty5.handler.codec.bytes

public Class ByteArrayEncoder

extends MessageToMessageEncoder<byte[]>
Class Inheritance
Imports
io.netty5.buffer.Buffer, io.netty5.channel.ChannelHandlerContext, .ChannelPipeline, io.netty5.handler.codec.LengthFieldPrepender, .MessageToMessageEncoder, java.util.List
Encodes the requested array of bytes into a Buffer. 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 Buffer as a message: 
void channelRead(ChannelHandlerContext ctx, byte[] bytes) {
    ...
}

Constructor Summary

AccessConstructor and Description
public
ByteArrayEncoder()

Method Summary

Modifier and TypeMethod and Description
protected void
encode(ChannelHandlerContext
the ChannelHandlerContext which this MessageToMessageEncoder belongs to.
ctx, byte[]
the message to encode to another one.
msg, List<Object>
the List into which produced output messages should be added.
out)

Overrides io.netty5.handler.codec.MessageToMessageEncoder.encode.

Encode from one message to another.
public boolean
isSharable()

Overrides default io.netty5.channel.ChannelHandler.isSharable.

Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline.
Inherited from io.netty5.handler.codec.MessageToMessageEncoder:
acceptOutboundMessageencodeAndClosewrite

Constructor Detail

ByteArrayEncoderback to summary
public ByteArrayEncoder()

Method Detail

encodeback to summary
protected void encode(ChannelHandlerContext ctx, byte[] msg, List<Object> out) throws Exception

Overrides io.netty5.handler.codec.MessageToMessageEncoder.encode.

Doc from io.netty5.handler.codec.MessageToMessageEncoder.encode.

Encode from one message to another. This method will be called for each written message that can be handled by this encoder.

The message will be disposed of after this call.

Subclasses that wish to sometimes pass messages through, should instead override the encodeAndClose(ChannelHandlerContext, Object, List) method.

Parameters
ctx:ChannelHandlerContext

the ChannelHandlerContext which this MessageToMessageEncoder belongs to.

msg:byte[]

the message to encode to another one.

out:List<Object>

the List into which produced output messages should be added.

Annotations
@Override
Exceptions
Exception:
is thrown if an error occurs.
isSharableback to summary
public boolean isSharable()

Overrides default io.netty5.channel.ChannelHandler.isSharable.

Doc from io.netty5.channel.ChannelHandler.isSharable.

Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline. By default, this method returns false. If this method returns false, you have to create a new handler instance every time you add it to a pipeline because it has unshared state such as member variables.

Annotations
@Override