Package org.drasyl.pipeline.handler.codec

Class MessageToMessageDecoder<I,A extends Address>

java.lang.Object

org.drasyl.pipeline.skeleton.HandlerAdapter

org.drasyl.pipeline.skeleton.AddressHandlerAdapter<A>

org.drasyl.pipeline.skeleton.SimpleInboundEventAwareHandler<I,Event,A>

org.drasyl.pipeline.skeleton.SimpleInboundHandler<I,A>

org.drasyl.pipeline.handler.codec.MessageToMessageDecoder<I,A>

All Implemented Interfaces:

Handler

public abstract class MessageToMessageDecoder<I,A extends Address>
extends SimpleInboundHandler<I,A>

SimpleInboundHandler which decodes from one message to one ore more other message(s).

For example here is an implementation which decodes an String to an Integer.

     public class StringToIntegerDecoder extends
             MessageToMessageDecoder<String,Address> {

         @Override
         public void decode(HandlerContext ctx, Address recipient, String message, List<Object> out)
                 throws Exception {
             out.add(message.length());
         }
     }
 

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 MessageToMessageDecoder will call ReferenceCounted.release() on encoded messages.

Constructor Summary

Constructors

Constructor	Description
MessageToMessageDecoder()

Method Summary

Modifier and Type	Method	Description
protected abstract void	decode(HandlerContext ctx, A sender, I msg, List<Object> out)	Decode from one message to one or more other.
protected void	matchedInbound(HandlerContext ctx, A sender, I msg, CompletableFuture<Void> future)	Is called for each message of type SimpleInboundEventAwareHandler.

Methods inherited from class org.drasyl.pipeline.skeleton.SimpleInboundHandler

matchedEvent, onEvent

Methods inherited from class org.drasyl.pipeline.skeleton.SimpleInboundEventAwareHandler

acceptEvent, acceptInbound, onInbound

Methods inherited from class org.drasyl.pipeline.skeleton.AddressHandlerAdapter

acceptAddress

Methods inherited from class org.drasyl.pipeline.skeleton.HandlerAdapter

onAdded, onException, onOutbound, onRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageToMessageDecoder

public MessageToMessageDecoder()

Method Detail

matchedInbound

protected void matchedInbound(HandlerContext ctx,
                              A sender,
                              I msg,
                              CompletableFuture<Void> future)
                       throws Exception

Description copied from class: SimpleInboundEventAwareHandler

Is called for each message of type SimpleInboundEventAwareHandler.

Specified by:

matchedInbound in class SimpleInboundEventAwareHandler<I,Event,A extends Address>

Parameters:

ctx - handler context

sender - the sender of the message

msg - the message

future - the future of the message

Throws:

Exception

decode

protected abstract void decode(HandlerContext ctx,
                               A sender,
                               I msg,
                               List<Object> out)
                        throws Exception

Decode from one message to one or more other. This method will be called for each inbound message that can be handled by this decoder.

Parameters:

ctx - the HandlerContext which this MessageToMessageDecoder belongs to

sender - the sender of the message

msg - the message to decode

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs