Class DatagramDnsResponseEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<AddressedEnvelope<DnsResponse, InetSocketAddress>>

io.netty.handler.codec.dns.DatagramDnsResponseEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@Sharable
public class DatagramDnsResponseEncoder
extends MessageToMessageEncoder<AddressedEnvelope<DnsResponse, InetSocketAddress>>

Encodes a DatagramDnsResponse (or an AddressedEnvelope of DnsResponse} into a DatagramPacket.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

Constructor	Description
DatagramDnsResponseEncoder()	Creates a new encoder with the default record encoder.
DatagramDnsResponseEncoder(DnsRecordEncoder recordEncoder)	Creates a new encoder with the specified recordEncoder.

Method Summary

Modifier and Type	Method	Description
protected ByteBuf	allocateBuffer(ChannelHandlerContext ctx, AddressedEnvelope<DnsResponse, InetSocketAddress> msg)	Allocate a ByteBuf which will be used for constructing a datagram packet.
protected void	encode(ChannelHandlerContext ctx, AddressedEnvelope<DnsResponse, InetSocketAddress> in, List<Object> out)	Encode from one message to an other.

Methods inherited from class MessageToMessageEncoder

acceptOutboundMessage, write

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. is part of ChannelInboundHandler
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

DatagramDnsResponseEncoder

public DatagramDnsResponseEncoder()

Creates a new encoder with the default record encoder.

DatagramDnsResponseEncoder

public DatagramDnsResponseEncoder(DnsRecordEncoder recordEncoder)

Creates a new encoder with the specified recordEncoder.

Method Details

encode

protected void encode(ChannelHandlerContext ctx,
 AddressedEnvelope<DnsResponse, InetSocketAddress> in,
 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<AddressedEnvelope<DnsResponse, InetSocketAddress>>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

in - 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

allocateBuffer

protected ByteBuf allocateBuffer(ChannelHandlerContext ctx,
 AddressedEnvelope<DnsResponse, InetSocketAddress> msg)
                          throws Exception

Allocate a ByteBuf which will be used for constructing a datagram packet. Sub-classes may override this method to return a ByteBuf with a perfect matching initial capacity.

Throws:

Exception