Package org.drasyl.pipeline

Class DefaultHandlerContext

java.lang.Object

org.drasyl.pipeline.DefaultHandlerContext

All Implemented Interfaces:

HandlerContext

public class DefaultHandlerContext
extends Object

The default handler context implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultHandlerContext(String name, Handler handler, DrasylConfig config, Pipeline pipeline, io.reactivex.rxjava3.core.Scheduler scheduler, Identity identity, TypeValidator inboundValidator, TypeValidator outboundValidator)	Generates a new default handler context for the given handler.

Method Summary

Modifier and Type	Method	Description
DrasylConfig	config()	Returns the corresponding DrasylConfig.
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(Address sender, Object msg, CompletableFuture<Void> future)	Received a message.
Handler	handler()	Returns the associated Handler.
Identity	identity()	Returns the identifier of this node.
TypeValidator	inboundValidator()	Returns the inbound type validator of this pipeline.
String	name()	Returns the name of the Handler.
TypeValidator	outboundValidator()	Returns the outbound type validator of this pipeline.
Pipeline	pipeline()	Returns the corresponding Pipeline.
io.reactivex.rxjava3.core.Scheduler	scheduler()	Implementation Note: This method should always return a scheduler, that differs from the normal pipeline scheduler.
CompletableFuture<Void>	write(Address recipient, Object msg, CompletableFuture<Void> future)	Request to write a message via this HandlerContext through the Pipeline.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHandlerContext

public DefaultHandlerContext(String name,
                             Handler handler,
                             DrasylConfig config,
                             Pipeline pipeline,
                             io.reactivex.rxjava3.core.Scheduler scheduler,
                             Identity identity,
                             TypeValidator inboundValidator,
                             TypeValidator outboundValidator)

Generates a new default handler context for the given handler.

Parameters:

name - the name of the handler

handler - the handler

config - the config of the drasyl node

pipeline - the corresponding pipeline object

scheduler - the corresponding scheduler

identity - the identity of the corresponding node

inboundValidator - the inbound validator of the pipeline

outboundValidator - the outbound validator of the pipeline

Method Detail

handler

public Handler handler()

Description copied from interface: HandlerContext

Returns the associated Handler.

Returns:

the associated Handler

name

public String name()

Description copied from interface: HandlerContext

Returns the name of the Handler.

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(Address sender,
                                        Object msg,
                                        CompletableFuture<Void> future)

Description copied from interface: HandlerContext

Received a message.

This will result in having the Handler.read(HandlerContext, Address, 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(Address 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()

Description copied from interface: HandlerContext

Returns the corresponding DrasylConfig.

Specified by:

config in interface HandlerContext

Returns:

the corresponding DrasylConfig

pipeline

public Pipeline pipeline()

Description copied from interface: HandlerContext

Returns the corresponding 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()

Description copied from interface: HandlerContext

Returns the identifier of this node.

Specified by:

identity in interface HandlerContext

Returns:

the identity of this node

inboundValidator

public TypeValidator inboundValidator()

Description copied from interface: HandlerContext

Returns the inbound type validator of this pipeline.

Specified by:

inboundValidator in interface HandlerContext

Returns:

the inbound type validator

outboundValidator

public TypeValidator outboundValidator()

Description copied from interface: HandlerContext

Returns the outbound type validator of this pipeline.

Specified by:

outboundValidator in interface HandlerContext

Returns:

the outbound type validator