Top Description Fields Constructors Methods
io.netty5.handler.codec

public abstract Class MessageToMessageCodec<INBOUND_IN, OUTBOUND_IN>

extends ChannelHandlerAdapter
Class Inheritance
Imports
io.netty5.channel.ChannelHandlerAdapter, .ChannelHandlerContext, io.netty5.util.ReferenceCounted, io.netty5.util.concurrent.Future, io.netty5.util.internal.TypeParameterMatcher, java.util.List
A Codec for on-the-fly encoding/decoding of message. This can be thought of as a combination of MessageToMessageDecoder and MessageToMessageEncoder. Here is an example of a MessageToMessageCodec which just decode from Integer to Long and encode from Long to Integer. 
    public class NumberCodec extends
            MessageToMessageCodec<Integer, Long> {
        @Override
        public Long decode(ChannelHandlerContext ctx, Integer msg, List<Object> out)
                throws Exception {
            out.add(msg.longValue());
        }

        @Override
        public Integer encode(ChannelHandlerContext ctx, Long msg, List<Object> out)
                throws Exception {
            out.add(msg.intValue());
        }
    }
Be aware that you need to call ReferenceCounted#retain() on messages that are just passed through if they are of type ReferenceCounted. This is needed as the MessageToMessageCodec will call ReferenceCounted#release() on encoded / decoded messages.

Field Summary

Modifier and TypeField and Description
private final MessageToMessageDecoder<Object>
decoder

private final MessageToMessageEncoder<Object>
encoder

private final TypeParameterMatcher
inboundMsgMatcher

private final TypeParameterMatcher
outboundMsgMatcher

Constructor Summary

AccessConstructor and Description
protected
MessageToMessageCodec()

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

protected
MessageToMessageCodec(Class<? extends INBOUND_IN>
The type of messages to decode
inboundMessageType, Class<? extends OUTBOUND_IN>
The type of messages to encode
outboundMessageType)

Create a new instance.

Method Summary

Modifier and TypeMethod and Description
public boolean
acceptInboundMessage(Object
the message
msg)

Returns true if and only if the specified message can be decoded by this codec.

public boolean
acceptOutboundMessage(Object
the message
msg)

Returns true if and only if the specified message can be encoded by this codec.

public void
channelRead(ChannelHandlerContext ctx, Object msg)

Overrides default io.netty5.channel.ChannelHandler.channelRead.

Invoked when the current Channel has read a message from the peer.
protected void
decode(ChannelHandlerContext ctx, INBOUND_IN msg)

protected void
decodeAndClose(ChannelHandlerContext ctx, INBOUND_IN msg)

protected void
encode(ChannelHandlerContext ctx, OUTBOUND_IN msg, List<Object> out)

protected void
encodeAndClose(ChannelHandlerContext ctx, OUTBOUND_IN msg, List<Object> out)

public Future<Void>
write(ChannelHandlerContext
the ChannelHandlerContext for which the write operation is made
ctx, Object
the message to write
msg)

Overrides default io.netty5.channel.ChannelHandler.write.

Called once a write operation is made.

Field Detail

decoderback to summary
private final MessageToMessageDecoder<Object> decoder
encoderback to summary
private final MessageToMessageEncoder<Object> encoder
inboundMsgMatcherback to summary
private final TypeParameterMatcher inboundMsgMatcher
outboundMsgMatcherback to summary
private final TypeParameterMatcher outboundMsgMatcher

Constructor Detail

MessageToMessageCodecback to summary
protected MessageToMessageCodec()

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

MessageToMessageCodecback to summary
protected MessageToMessageCodec(Class<? extends INBOUND_IN> inboundMessageType, Class<? extends OUTBOUND_IN> outboundMessageType)

Create a new instance.

Parameters
inboundMessageType:Class<? extends INBOUND_IN>

The type of messages to decode

outboundMessageType:Class<? extends OUTBOUND_IN>

The type of messages to encode

Method Detail

acceptInboundMessageback to summary
public boolean acceptInboundMessage(Object msg) throws Exception

Returns true if and only if the specified message can be decoded by this codec.

Parameters
msg:Object

the message

acceptOutboundMessageback to summary
public boolean acceptOutboundMessage(Object msg) throws Exception

Returns true if and only if the specified message can be encoded by this codec.

Parameters
msg:Object

the message

channelReadback to summary
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelRead.

Doc from io.netty5.channel.ChannelHandler.channelRead.

Invoked when the current Channel has read a message from the peer.

Annotations
@Override
decodeback to summary
protected void decode(ChannelHandlerContext ctx, INBOUND_IN msg) throws Exception
See Also
MessageToMessageDecoder#decode(ChannelHandlerContext, Object)
decodeAndCloseback to summary
protected void decodeAndClose(ChannelHandlerContext ctx, INBOUND_IN msg) throws Exception
See Also
MessageToMessageDecoder#decodeAndClose(ChannelHandlerContext, Object)
encodeback to summary
protected void encode(ChannelHandlerContext ctx, OUTBOUND_IN msg, List<Object> out) throws Exception
See Also
MessageToMessageEncoder#encode(ChannelHandlerContext, Object, List)
encodeAndCloseback to summary
protected void encodeAndClose(ChannelHandlerContext ctx, OUTBOUND_IN msg, List<Object> out) throws Exception
See Also
MessageToMessageEncoder#encodeAndClose(ChannelHandlerContext, Object, List)
writeback to summary
public Future<Void> write(ChannelHandlerContext ctx, Object msg)

Overrides default io.netty5.channel.ChannelHandler.write.

Doc from io.netty5.channel.ChannelHandler.write.

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:ChannelHandlerContext

the ChannelHandlerContext for which the write operation is made

msg:Object

the message to write

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations
@Override