Package org.drasyl.pipeline

Class AbstractEndHandler

java.lang.Object

org.drasyl.pipeline.AbstractEndHandler

All Implemented Interfaces:

Handler, HandlerContext

public abstract class AbstractEndHandler
extends Object
implements Handler

Skeleton implementation for end handler of the Pipeline.

Constructor Summary

Constructors

Constructor	Description
AbstractEndHandler(String name, DrasylConfig config, Pipeline pipeline, io.reactivex.rxjava3.core.Scheduler scheduler, Identity identity, TypeValidator validator)

Method Summary

Modifier and Type	Method	Description
DrasylConfig	config()
void	eventTriggered(HandlerContext ctx, Event event, CompletableFuture<Void> future)	Gets called if a Event was emitted.
void	exceptionCaught(HandlerContext ctx, Exception cause)	Gets called if a Exception was thrown.
CompletableFuture<Void>	fireEventTriggered(Event event, CompletableFuture<Void> future)	Received an event.
HandlerContext	fireExceptionCaught(Exception cause)	Received an Throwable in one of the inbound operations.
CompletableFuture<Void>	fireRead(CompressedPublicKey sender, Object msg, CompletableFuture<Void> future)	Received a message.
Handler	handler()
void	handlerAdded(HandlerContext ctx)	Gets called after the Handler was added to the actual context and it's ready to handle events.
void	handlerRemoved(HandlerContext ctx)	Gets called after the Handler was removed from the actual context and it doesn't handle events anymore.
Identity	identity()
String	name()
Pipeline	pipeline()
void	read(HandlerContext ctx, CompressedPublicKey sender, Object msg, CompletableFuture<Void> future)	Gets called if a Object was received.
io.reactivex.rxjava3.core.Scheduler	scheduler()	Implementation Note: This method should always return a scheduler, that differs from the normal pipeline scheduler.
TypeValidator	validator()
CompletableFuture<Void>	write(CompressedPublicKey recipient, Object msg, CompletableFuture<Void> future)	Request to write a message via this HandlerContext through the Pipeline.
void	write(HandlerContext ctx, CompressedPublicKey recipient, Object msg, CompletableFuture<Void> future)	Gets called if a Object was send from the application to a recipient.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEndHandler

public AbstractEndHandler(String name,
                          DrasylConfig config,
                          Pipeline pipeline,
                          io.reactivex.rxjava3.core.Scheduler scheduler,
                          Identity identity,
                          TypeValidator validator)

Method Detail

handler

public Handler handler()

Specified by:

handler in interface HandlerContext

Returns:

the associated Handler

handlerAdded

public void handlerAdded(HandlerContext ctx)

Description copied from interface: Handler

Gets called after the Handler was added to the actual context and it's ready to handle events.

Specified by:

handlerAdded in interface Handler

handlerRemoved

public void handlerRemoved(HandlerContext ctx)

Description copied from interface: Handler

Gets called after the Handler was removed from the actual context and it doesn't handle events anymore.

Specified by:

handlerRemoved in interface Handler

read

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

Description copied from interface: Handler

Gets called if a Object was received.

Specified by:

read in interface Handler

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

Parameters:

ctx - handler context

event - the event

future - a future for the message

exceptionCaught

public void exceptionCaught(HandlerContext ctx,
                            Exception cause)

Description copied from interface: Handler

Gets called if a Exception was thrown.

Specified by:

exceptionCaught in interface Handler

write

public void write(HandlerContext ctx,
                  CompressedPublicKey recipient,
                  Object msg,
                  CompletableFuture<Void> future)

Description copied from interface: Handler

Gets called if a Object was send from the application to a recipient.

Specified by:

write in interface Handler

Parameters:

ctx - handler context

recipient - the recipient of the message

msg - the message

future - a future for the message

name

public String name()

Specified by:

name in interface HandlerContext

Returns:

the name of the Handler

fireExceptionCaught

public HandlerContext fireExceptionCaught(Exception cause)

Description copied from interface: HandlerContext

Received an Throwable in one of the inbound operations.

This will result in having the Handler.exceptionCaught(HandlerContext, Exception) method called of the next Handler contained in the Pipeline.

Specified by:

fireExceptionCaught in interface HandlerContext

Parameters:

cause - the cause

fireRead

public CompletableFuture<Void> fireRead(CompressedPublicKey sender,
                                        Object msg,
                                        CompletableFuture<Void> future)

Description copied from interface: HandlerContext

Received a message.

This will result in having the Handler.read(HandlerContext, CompressedPublicKey, Object, CompletableFuture) method called of the next Handler contained in the Pipeline.

Specified by:

fireRead in interface HandlerContext

Parameters:

sender - the sender of the message

msg - the message

future - the future of the message

fireEventTriggered

public CompletableFuture<Void> fireEventTriggered(Event event,
                                                  CompletableFuture<Void> future)

Description copied from interface: HandlerContext

Received an event.

This will result in having the Handler.eventTriggered(HandlerContext, Event, CompletableFuture) method called of the next Handler contained in the Pipeline.

Specified by:

fireEventTriggered in interface HandlerContext

Parameters:

event - the event

future - the future of the message

write

public CompletableFuture<Void> write(CompressedPublicKey recipient,
                                     Object msg,
                                     CompletableFuture<Void> future)

Description copied from interface: HandlerContext

Request to write a message via this HandlerContext through the Pipeline.

Specified by:

write in interface HandlerContext

Parameters:

recipient - the recipient of the message

msg - the message

future - the future of the message

config

public DrasylConfig config()

Specified by:

config in interface HandlerContext

Returns:

the corresponding DrasylConfig

pipeline

public Pipeline pipeline()

Specified by:

pipeline in interface HandlerContext

Returns:

the corresponding Pipeline

scheduler

public io.reactivex.rxjava3.core.Scheduler scheduler()

Description copied from interface: HandlerContext

Implementation Note: This method should always return a scheduler, that differs from the normal pipeline scheduler. E.g. the DrasylScheduler.getInstanceHeavy()

Specified by:

scheduler in interface HandlerContext

Returns:

the corresponding Scheduler

identity

public Identity identity()

Specified by:

identity in interface HandlerContext

Returns:

the identity of this node

validator

public TypeValidator validator()

Specified by:

validator in interface HandlerContext

Returns:

the type validator