Module io.netty5.codec

Package io.netty5.handler.codec

Class MessageToByteEncoder<I>

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

io.netty5.handler.codec.MessageToByteEncoder<I>

All Implemented Interfaces:

ChannelHandler

Direct Known Subclasses:

TcpDnsQueryEncoder

public abstract class MessageToByteEncoder<I>
extends ChannelHandlerAdapter

ChannelHandler which encodes message in a stream-like fashion from one message to a Buffer.

Example implementation which encodes Integers to a Buffer.

     public class IntegerEncoder extends MessageToByteEncoder<Integer> {
         @Override
         public void encode(ChannelHandlerContext ctx, Integer msg, Buffer out)
                 throws Exception {
             out.writeInt(msg);
         }
     }
 

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageToByteEncoder()	Create a new instance which will try to detect the types to match out of the type parameter of the class.
protected	MessageToByteEncoder(Class<? extends I> outboundMessageType)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected abstract Buffer	allocateBuffer(ChannelHandlerContext ctx, I msg)	Allocate a Buffer which will be used as argument of #encode(ChannelHandlerContext, I, Buffer).
protected abstract void	encode(ChannelHandlerContext ctx, I msg, Buffer out)	Encode a message into a Buffer.
Future<Void>	write(ChannelHandlerContext ctx, Object msg)	Called once a write operation is made.

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

Constructor Detail

MessageToByteEncoder

protected MessageToByteEncoder()

Create a new instance which will try to detect the types to match out of the type parameter of the class.

MessageToByteEncoder

protected MessageToByteEncoder(Class<? extends I> outboundMessageType)

Create a new instance.

Parameters:

outboundMessageType - The type of messages to match.

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

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

Throws:

Exception

write

public Future<Void> write(ChannelHandlerContext ctx,
                          Object msg)

Description copied from interface: ChannelHandler

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called.

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

Returns:

the Future which will be notified once the operation completes.

allocateBuffer

protected abstract Buffer allocateBuffer(ChannelHandlerContext ctx,
                                         I msg)
                                  throws Exception

Allocate a Buffer which will be used as argument of #encode(ChannelHandlerContext, I, Buffer).

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to be encoded

Throws:

Exception

encode

protected abstract void encode(ChannelHandlerContext ctx,
                               I msg,
                               Buffer out)
                        throws Exception

Encode a message into a Buffer. This method will be called for each written message that can be handled by this encoder.

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the Buffer into which the encoded message will be written

Throws:

Exception - is thrown if an error occurs