java.lang.Object
- io.netty5.channel.ChannelHandlerAdapter
- - io.netty5.handler.codec.MessageToMessageEncoder<byte[]>
  - - io.netty5.handler.codec.bytes.ByteArrayEncoder

All Implemented Interfaces:: ChannelHandler

public class ByteArrayEncoder
extends MessageToMessageEncoder<byte[]>

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

Constructors
Constructor Description

ByteArrayEncoder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`encode(ChannelHandlerContext ctx, byte[] msg, List<Object> out)`	Encode from one message to another.
`boolean`	`isSharable()`	Returns `true` if this handler is sharable and thus can be added to more than one `ChannelPipeline`.

Methods inherited from class io.netty5.handler.codec.MessageToMessageEncoder
acceptOutboundMessage, encodeAndClose, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty5.channel.ChannelHandler
bind, channelActive, channelExceptionCaught, channelInactive, channelInboundEvent, channelRead, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown

- Constructor Detail
  - ByteArrayEncoder
```
public ByteArrayEncoder()
```
- Method Detail
  - isSharable
```
public boolean isSharable()
```
    Description copied from interface: ChannelHandler
    
    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.
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      byte[] msg,
                      List<Object> out)
               throws Exception
```
    Description copied from class: MessageToMessageEncoder
    
    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 MessageToMessageEncoder.encodeAndClose(ChannelHandlerContext, Object, List) method.
    
    Overrides:
    
    encode in class MessageToMessageEncoder<byte[]>
    
    Parameters:
    
    ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to.
    
    msg - the message to encode to another one.
    
    out - the List into which produced output messages should be added.
    
    Throws:
    
    Exception - is thrown if an error occurs.

Class ByteArrayEncoder

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty5.channel.ChannelHandler

Constructor Detail

ByteArrayEncoder

Method Detail

isSharable

encode