Netty5/Codec 5.0.0.Alpha5 · io.netty5.handler.codec.base64.Base64Encoder

Encodes a Buffer into a Base64-encoded Buffer. A typical setup for TCP/IP would be:

ChannelPipeline pipeline = ...;

// Decoders
pipeline.addLast("frameDecoder", new DelimiterBasedFrameDecoder(80, Delimiters#nulDelimiter()));
pipeline.addLast("base64Decoder", new Base64Decoder());

// Encoder
pipeline.addLast("base64Encoder", new Base64Encoder());

Modifier and Type	Field and Description
private final boolean	breakLines
private final Base64Dialect	dialect

Constructor Summary

Access	Constructor and Description
public	Base64Encoder()
public	Base64Encoder(boolean breakLines)
public	Base64Encoder(boolean breakLines, Base64Dialect dialect)

Method Summary

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to. ctx, Buffer 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:: acceptOutboundMessage encodeAndClose write

Field Detail

breakLines	back to summary
private final boolean breakLines

dialect	back to summary
private final Base64Dialect dialect

Constructor Detail

Base64Encoder	back to summary
public Base64Encoder()

Base64Encoder	back to summary
public Base64Encoder(boolean breakLines)

Base64Encoder	back to summary
public Base64Encoder(boolean breakLines, Base64Dialect dialect)

Method Detail

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, Buffer 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:Buffer 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.

protected void encode(ChannelHandlerContext ctx, Buffer 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:Buffer: 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.

isSharable back to summary

isSharable	back 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

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.