Package org.drasyl.pipeline

Interface HandlerContext

All Known Implementing Classes:

DefaultHandlerContext

public interface HandlerContext

Enables a Handler to interact with its Pipeline and other handlers. Among other things a handler can notify the next Handler in the Pipeline as well as modify the Pipeline it belongs to dynamically.

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.

Method Details

name

String name()

Returns the name of the Handler.

Returns:

the name of the Handler

handler

Handler handler()

Returns the associated Handler.

Returns:

the associated Handler

fireExceptionCaught

HandlerContext fireExceptionCaught(Exception cause)

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.

Parameters:

cause - the cause

fireRead

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

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.

Parameters:

sender - the sender of the message

msg - the message

future - the future of the message

fireEventTriggered

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

Received an event.

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

Parameters:

event - the event

future - the future of the message

write

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

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

Parameters:

recipient - the recipient of the message

msg - the message

future - the future of the message

config

DrasylConfig config()

Returns the corresponding DrasylConfig.

Returns:

the corresponding DrasylConfig

pipeline

Pipeline pipeline()

Returns the corresponding Pipeline.

Returns:

the corresponding Pipeline

scheduler

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

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

Returns:

the corresponding Scheduler

identity

Identity identity()

Returns the identifier of this node.

Returns:

the identity of this node

inboundValidator

TypeValidator inboundValidator()

Returns the inbound type validator of this pipeline.

Returns:

the inbound type validator

outboundValidator

TypeValidator outboundValidator()

Returns the outbound type validator of this pipeline.

Returns:

the outbound type validator