Package org.drasyl.pipeline.codec

Class Codec<E,D,A extends Address>

java.lang.Object

org.drasyl.pipeline.HandlerAdapter

org.drasyl.pipeline.AddressHandlerAdapter<A>

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

org.drasyl.pipeline.SimpleDuplexHandler<E,Event,D,A>

org.drasyl.pipeline.codec.Codec<E,D,A>

All Implemented Interfaces:

Handler

Direct Known Subclasses:

DefaultCodec

public abstract class Codec<E,D,A extends Address>
extends SimpleDuplexHandler<E,Event,D,A>

Standard interface for all codecs of the Pipeline.
A codec can be used to encode/decode a given set of objects into the correct format to process the object in the ongoing steps.
A codec must have a symmetrical construction. encode(HandlerContext, Object, Consumer) converts an object of type D into type E and decode(HandlerContext, Object, Consumer) vice versa.

Note: You can use the HandlerContext.inboundValidator()} or HandlerContext.outboundValidator()} to check if a given Class is allowed to be encode/decode.

Constructor Summary

Constructors

Constructor	Description
Codec()

Method Summary

Modifier and Type	Method	Description
protected void	matchedEventTriggered(HandlerContext ctx, Event event, CompletableFuture<Void> future)	Is called for each event of type SimpleInboundHandler.
protected void	matchedRead(HandlerContext ctx, A sender, E msg, CompletableFuture<Void> future)	Is called for each message of type SimpleInboundHandler.
protected void	matchedWrite(HandlerContext ctx, A recipient, D msg, CompletableFuture<Void> future)	Is called for each message of type SimpleDuplexHandler.

Methods inherited from class org.drasyl.pipeline.SimpleDuplexHandler

acceptOutbound, write

Methods inherited from class org.drasyl.pipeline.SimpleInboundHandler

acceptEvent, acceptInbound, eventTriggered, read

Methods inherited from class org.drasyl.pipeline.AddressHandlerAdapter

acceptAddress

Methods inherited from class org.drasyl.pipeline.HandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

Codec

public Codec()

Method Detail

matchedEventTriggered

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

Description copied from class: SimpleInboundHandler

Is called for each event of type SimpleInboundHandler.

Specified by:

matchedEventTriggered in class SimpleInboundHandler<E,Event,A extends Address>

Parameters:

ctx - handler context

event - the event

future - the future of the message

matchedRead

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

Description copied from class: SimpleInboundHandler

Is called for each message of type SimpleInboundHandler.

Specified by:

matchedRead in class SimpleInboundHandler<E,Event,A extends Address>

Parameters:

ctx - handler context

sender - the sender of the message

msg - the message

future - the future of the message

matchedWrite

protected void matchedWrite(HandlerContext ctx,
                            A recipient,
                            D msg,
                            CompletableFuture<Void> future)

Description copied from class: SimpleDuplexHandler

Is called for each message of type SimpleDuplexHandler.

Specified by:

matchedWrite in class SimpleDuplexHandler<E,Event,D,A extends Address>

Parameters:

ctx - handler context

recipient - the recipient of the message

msg - the message

future - a future for the message