Module io.netty5.codec

Package io.netty5.handler.codec.base64

Class Base64Decoder

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

io.netty5.handler.codec.MessageToMessageDecoder<Buffer>

io.netty5.handler.codec.base64.Base64Decoder

All Implemented Interfaces:

ChannelHandler

public class Base64Decoder
extends MessageToMessageDecoder<Buffer>

Decodes a Base64-encoded Buffer or US-ASCII String into a Buffer. Please note that this decoder must be used with a proper ByteToMessageDecoder such as DelimiterBasedFrameDecoder if you are using a stream-based transport such as TCP/IP. A typical decoder 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());
 

Constructor Summary

Constructors

Constructor	Description
Base64Decoder()
Base64Decoder(Base64Dialect dialect)

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext ctx, Buffer msg)	Decode 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.MessageToMessageDecoder

acceptInboundMessage, channelRead, decodeAndClose

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, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

Constructor Detail

Base64Decoder

public Base64Decoder()

Base64Decoder

public Base64Decoder(Base64Dialect dialect)

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.

decode

protected void decode(ChannelHandlerContext ctx,
                      Buffer msg)
               throws Exception

Description copied from class: MessageToMessageDecoder

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

The message will be disposed of after this call.

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

Overrides:

decode in class MessageToMessageDecoder<Buffer>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to another one

Throws:

Exception - is thrown if an error occurs