Module io.netty5.codec

Package io.netty5.handler.codec

Class DatagramPacketDecoder

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

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

io.netty5.handler.codec.DatagramPacketDecoder

All Implemented Interfaces:

ChannelHandler

public class DatagramPacketDecoder
extends MessageToMessageDecoder<DatagramPacket>

A decoder that decodes the content of the received DatagramPacket using the specified Buffer decoder. E.g.,

 ChannelPipeline pipeline = ...;
 pipeline.addLast("udpDecoder", new DatagramPacketDecoder(new ByteArrayDecoder(...));
 

Constructor Summary

Constructors

Constructor	Description
DatagramPacketDecoder(MessageToMessageDecoder<Buffer> decoder)	Create a DatagramPacket decoder using the specified Buffer decoder.

Method Summary

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)	Returns true if the given message should be handled.
void	channelActive(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext is now active
void	channelExceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Gets called if a Throwable was thrown when handling inbound events.
void	channelInactive(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.
void	channelInboundEvent(ChannelHandlerContext ctx, Object evt)	Gets called if a custom inbound event happened.
void	channelReadComplete(ChannelHandlerContext ctx)	Invoked when the last message read by the current read operation has been consumed by ChannelHandler.channelRead(ChannelHandlerContext, Object).
void	channelRegistered(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext was registered with its EventLoop
void	channelUnregistered(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext was unregistered from its EventLoop
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Gets called once the writable state of a Channel changed.
protected void	decode(ChannelHandlerContext ctx, DatagramPacket msg)	Decode from one message to another.
void	handlerAdded(ChannelHandlerContext ctx)	Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.
void	handlerRemoved(ChannelHandlerContext ctx)	Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.
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

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, channelShutdown, close, connect, deregister, disconnect, flush, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

Constructor Detail

DatagramPacketDecoder

public DatagramPacketDecoder(MessageToMessageDecoder<Buffer> decoder)

Create a DatagramPacket decoder using the specified Buffer decoder.

Parameters:

decoder - the specified Buffer decoder

Method Detail

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)
                             throws Exception

Description copied from class: MessageToMessageDecoder

Returns true if the given message should be handled. If false it will be passed to the next ChannelHandler in the ChannelPipeline.

Overrides:

acceptInboundMessage in class MessageToMessageDecoder<DatagramPacket>

Throws:

Exception

decode

protected void decode(ChannelHandlerContext ctx,
                      DatagramPacket 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<DatagramPacket>

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

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

Description copied from interface: ChannelHandler

The Channel of the ChannelHandlerContext was registered with its EventLoop

Throws:

Exception

channelUnregistered

public void channelUnregistered(ChannelHandlerContext ctx)
                         throws Exception

Description copied from interface: ChannelHandler

The Channel of the ChannelHandlerContext was unregistered from its EventLoop

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from interface: ChannelHandler

The Channel of the ChannelHandlerContext is now active

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from interface: ChannelHandler

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Throws:

Exception

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws Exception

Description copied from interface: ChannelHandler

Invoked when the last message read by the current read operation has been consumed by ChannelHandler.channelRead(ChannelHandlerContext, Object). If ChannelOption.AUTO_READ is off, no further attempt to read an inbound data from the current Channel will be made until ChannelHandlerContext.read() is called.

Throws:

Exception

channelInboundEvent

public void channelInboundEvent(ChannelHandlerContext ctx,
                                Object evt)
                         throws Exception

Description copied from interface: ChannelHandler

Gets called if a custom inbound event happened.

Throws:

Exception

channelWritabilityChanged

public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws Exception

Description copied from interface: ChannelHandler

Gets called once the writable state of a Channel changed. You can check the state with Channel.writableBytes() or Channel.isWritable().

Throws:

Exception

channelExceptionCaught

public void channelExceptionCaught(ChannelHandlerContext ctx,
                                   Throwable cause)
                            throws Exception

Description copied from interface: ChannelHandler

Gets called if a Throwable was thrown when handling inbound events.

Throws:

Exception

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from interface: ChannelHandler

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Throws:

Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Description copied from interface: ChannelHandler

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Throws:

Exception

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.