io.netty.handler.codec

Class DatagramPacketEncoder<M>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<io.netty.channel.AddressedEnvelope<M,InetSocketAddress>>

io.netty.handler.codec.DatagramPacketEncoder<M>

Type Parameters:

M - the type of message to be encoded

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

public class DatagramPacketEncoder<M>
extends MessageToMessageEncoder<io.netty.channel.AddressedEnvelope<M,InetSocketAddress>>

An encoder that encodes the content in AddressedEnvelope to DatagramPacket using the specified message encoder. E.g.,

 ChannelPipeline pipeline = ...;
 pipeline.addLast("udpEncoder", new DatagramPacketEncoder(new ProtobufEncoder(...));
 

Note: As UDP packets are out-of-order, you should make sure the encoded message size are not greater than the max safe packet size in your particular network path which guarantees no packet fragmentation.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
DatagramPacketEncoder(MessageToMessageEncoder<? super M> encoder) Create an encoder that encodes the content in AddressedEnvelope to DatagramPacket using the specified message encoder.

Method Summary

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(Object msg) Returns true if the given message should be handled.
void	bind(io.netty.channel.ChannelHandlerContext ctx, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	connect(io.netty.channel.ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	deregister(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	disconnect(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.AddressedEnvelope<M,InetSocketAddress> msg, List<Object> out) Encode from one message to an other.
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
void	flush(io.netty.channel.ChannelHandlerContext ctx)
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
boolean	isSharable()
void	read(io.netty.channel.ChannelHandlerContext ctx)

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

write

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatagramPacketEncoder

public DatagramPacketEncoder(MessageToMessageEncoder<? super M> encoder)

Create an encoder that encodes the content in AddressedEnvelope to DatagramPacket using the specified message encoder.

Parameters:

encoder - the specified message encoder

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Description copied from class: MessageToMessageEncoder

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

Overrides:

acceptOutboundMessage in class MessageToMessageEncoder<io.netty.channel.AddressedEnvelope<M,InetSocketAddress>>

Throws:

Exception

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.channel.AddressedEnvelope<M,InetSocketAddress> msg,
                      List<Object> out)
               throws Exception

Description copied from class: MessageToMessageEncoder

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

Specified by:

encode in class MessageToMessageEncoder<io.netty.channel.AddressedEnvelope<M,InetSocketAddress>>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the List into which the encoded msg should be added needs to do some kind of aggregation

Throws:

Exception - is thrown if an error occurs

bind

public void bind(io.netty.channel.ChannelHandlerContext ctx,
                 SocketAddress localAddress,
                 io.netty.channel.ChannelPromise promise)
          throws Exception

Specified by:

bind in interface io.netty.channel.ChannelOutboundHandler

Overrides:

bind in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

connect

public void connect(io.netty.channel.ChannelHandlerContext ctx,
                    SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    io.netty.channel.ChannelPromise promise)
             throws Exception

Specified by:

connect in interface io.netty.channel.ChannelOutboundHandler

Overrides:

connect in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

disconnect

public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)
                throws Exception

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundHandler

Overrides:

disconnect in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

close in interface io.netty.channel.ChannelOutboundHandler

Overrides:

close in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

deregister

public void deregister(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)
                throws Exception

Specified by:

deregister in interface io.netty.channel.ChannelOutboundHandler

Overrides:

deregister in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

read

public void read(io.netty.channel.ChannelHandlerContext ctx)
          throws Exception

Specified by:

read in interface io.netty.channel.ChannelOutboundHandler

Overrides:

read in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx)
           throws Exception

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

Overrides:

flush in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

handlerRemoved

public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

isSharable

public boolean isSharable()

Overrides:

isSharable in class io.netty.channel.ChannelHandlerAdapter