Package org.drasyl.pipeline.skeleton

Class SimpleInboundEventAwareHandler<I,E,A extends Address>

java.lang.Object

org.drasyl.pipeline.skeleton.HandlerAdapter

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

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

All Implemented Interfaces:

Handler

Direct Known Subclasses:

SimpleDuplexEventAwareHandler, SimpleInboundHandler

public abstract class SimpleInboundEventAwareHandler<I,E,A extends Address>
extends AddressHandlerAdapter<A>

HandlerAdapter which allows to explicit only handle a specific type of inbound messages and events.

For example here is an implementation which only handle inbound MyMessage messages and MessageEvent events.

     public class MessageEventHandler extends
             SimpleInboundEventAwareHandler<MyMessage, MessageEvent,
             CompressedPublicKey> {

        @Override
         protected void matchedEventTriggered(HandlerContext ctx,
             MessageEvent event) {
             System.out.println(event);
         }

        @Override
         protected void matchedRead(HandlerContext ctx,
             CompressedPublicKey sender, MyMessage msg,
             CompletableFuture<Void> future) {
             System.out.println(msg);
         }
     }
 

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleInboundEventAwareHandler()	Create a new instance which will try to detect the types to match out of the type parameter of the class.
protected	SimpleInboundEventAwareHandler(Class<? extends I> inboundMessageType, Class<? extends E> inboundEventType, Class<? extends A> addressType)	Create a new instance

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptEvent(Event msg)	Returns true if the given event should be handled.
protected boolean	acceptInbound(Object msg)	Returns true if the given message should be handled.
void	eventTriggered(HandlerContext ctx, Event event, CompletableFuture<Void> future)	Gets called if a Event was emitted.
protected abstract void	matchedEventTriggered(HandlerContext ctx, E event, CompletableFuture<Void> future)	Is called for each event of type SimpleInboundEventAwareHandler.
protected abstract void	matchedRead(HandlerContext ctx, A sender, I msg, CompletableFuture<Void> future)	Is called for each message of type SimpleInboundEventAwareHandler.
void	read(HandlerContext ctx, Address sender, Object msg, CompletableFuture<Void> future)	Gets called if a Object was received.

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

acceptAddress

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

exceptionCaught, handlerAdded, handlerRemoved, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleInboundEventAwareHandler

protected SimpleInboundEventAwareHandler()

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

SimpleInboundEventAwareHandler

protected SimpleInboundEventAwareHandler(Class<? extends I> inboundMessageType,
                                         Class<? extends E> inboundEventType,
                                         Class<? extends A> addressType)

Create a new instance

Parameters:

inboundMessageType - the type of messages to match

inboundEventType - the type of events to match

addressType - the type of the address to match

Method Detail

read

public void read(HandlerContext ctx,
                 Address sender,
                 Object msg,
                 CompletableFuture<Void> future)

Description copied from interface: Handler

Gets called if a Object was received.

Specified by:

read in interface Handler

Overrides:

read in class HandlerAdapter

Parameters:

ctx - handler context

sender - the sender of the message

msg - the message

future - a future for the message

eventTriggered

public void eventTriggered(HandlerContext ctx,
                           Event event,
                           CompletableFuture<Void> future)

Description copied from interface: Handler

Gets called if a Event was emitted.

Specified by:

eventTriggered in interface Handler

Overrides:

eventTriggered in class HandlerAdapter

Parameters:

ctx - handler context

event - the event

future - a future for the message

acceptEvent

protected boolean acceptEvent(Event msg)

Returns true if the given event should be handled. If false it will be passed to the next Handler in the Pipeline.

matchedEventTriggered

protected abstract void matchedEventTriggered(HandlerContext ctx,
                                              E event,
                                              CompletableFuture<Void> future)

Is called for each event of type SimpleInboundEventAwareHandler.

Parameters:

ctx - handler context

event - the event

future - the future of the message

acceptInbound

protected boolean acceptInbound(Object msg)

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

matchedRead

protected abstract void matchedRead(HandlerContext ctx,
                                    A sender,
                                    I msg,
                                    CompletableFuture<Void> future)

Is called for each message of type SimpleInboundEventAwareHandler.

Parameters:

ctx - handler context

sender - the sender of the message

msg - the message

future - the future of the message