Package org.drasyl.pipeline

Class AbstractPipeline

java.lang.Object

org.drasyl.pipeline.AbstractPipeline

All Implemented Interfaces:

Pipeline

Direct Known Subclasses:

DrasylPipeline, EmbeddedPipeline

public abstract class AbstractPipeline
extends Object
implements Pipeline

Abstract Pipeline implementation, that needs head and tail.

Field Summary

Fields

Modifier and Type	Field	Description
protected DrasylConfig	config
protected DrasylScheduler	dependentScheduler
protected Map<String,org.drasyl.pipeline.AbstractHandlerContext>	handlerNames
protected org.drasyl.pipeline.AbstractEndHandler	head
protected Identity	identity
protected Serialization	inboundSerialization
protected DrasylScheduler	independentScheduler
protected Serialization	outboundSerialization
protected PeersManager	peersManager
protected org.drasyl.pipeline.AbstractEndHandler	tail

Constructor Summary

Constructors

Constructor	Description
AbstractPipeline()

Method Summary

Modifier and Type	Method	Description
Pipeline	addAfter(String baseName, String name, Handler handler)	Inserts a Handler after an existing handler of this pipeline.
Pipeline	addBefore(String baseName, String name, Handler handler)	Inserts a Handler before an existing handler of this pipeline.
Pipeline	addFirst(String name, Handler handler)	Inserts a Handler at the first position of this pipeline.
Pipeline	addLast(String name, Handler handler)	Appends a Handler at the last position of this pipeline.
HandlerContext	context(String name)	Returns the context object of the Handler with the specified name in this pipeline.
Handler	get(String name)	Returns the Handler with the specified name in this pipeline.
protected void	initPointer()
CompletableFuture<Void>	processInbound(Event event)	Processes an inbound event by the pipeline.
CompletableFuture<Void>	processInbound(Address sender, Object msg)	Processes an inbound message by the pipeline.
CompletableFuture<Void>	processOutbound(Address recipient, Object msg)	Processes an outbound message by the pipeline.
Pipeline	remove(String name)	Removes the Handler with the specified name from this pipeline.
Pipeline	replace(String oldName, String newName, Handler newHandler)	Replaces the Handler of the specified name with a new handler in this pipeline.

Methods inherited from class java.lang.Object

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

Field Detail

handlerNames

protected Map<String,org.drasyl.pipeline.AbstractHandlerContext> handlerNames

head

protected org.drasyl.pipeline.AbstractEndHandler head

tail

protected org.drasyl.pipeline.AbstractEndHandler tail

dependentScheduler

protected DrasylScheduler dependentScheduler

independentScheduler

protected DrasylScheduler independentScheduler

config

protected DrasylConfig config

identity

protected Identity identity

peersManager

protected PeersManager peersManager

inboundSerialization

protected Serialization inboundSerialization

outboundSerialization

protected Serialization outboundSerialization

Constructor Detail

AbstractPipeline

public AbstractPipeline()

Method Detail

initPointer

protected void initPointer()

addFirst

public Pipeline addFirst(String name,
                         Handler handler)

Description copied from interface: Pipeline

Inserts a Handler at the first position of this pipeline.

Specified by:

addFirst in interface Pipeline

Parameters:

name - the name of the handler to insert first

handler - the handler to insert first

addLast

public Pipeline addLast(String name,
                        Handler handler)

Description copied from interface: Pipeline

Appends a Handler at the last position of this pipeline.

Specified by:

addLast in interface Pipeline

Parameters:

name - the name of the handler to append

handler - the handler to append

addBefore

public Pipeline addBefore(String baseName,
                          String name,
                          Handler handler)

Description copied from interface: Pipeline

Inserts a Handler before an existing handler of this pipeline.

Specified by:

addBefore in interface Pipeline

Parameters:

baseName - the name of the existing handler

name - the name of the handler to insert before

handler - the handler to insert before

addAfter

public Pipeline addAfter(String baseName,
                         String name,
                         Handler handler)

Description copied from interface: Pipeline

Inserts a Handler after an existing handler of this pipeline.

Specified by:

addAfter in interface Pipeline

Parameters:

baseName - the name of the existing handler

name - the name of the handler to insert after

handler - the handler to insert after

remove

public Pipeline remove(String name)

Description copied from interface: Pipeline

Removes the Handler with the specified name from this pipeline.

Specified by:

remove in interface Pipeline

Parameters:

name - the name under which the Handler was stored.

replace

public Pipeline replace(String oldName,
                        String newName,
                        Handler newHandler)

Description copied from interface: Pipeline

Replaces the Handler of the specified name with a new handler in this pipeline.

Specified by:

replace in interface Pipeline

Parameters:

oldName - the name of the Handler to be replaced

newName - the name under which the replacement should be added

newHandler - the Handler which is used as replacement

get

public Handler get(String name)

Description copied from interface: Pipeline

Returns the Handler with the specified name in this pipeline.

Specified by:

get in interface Pipeline

Returns:

the handler with the specified name. null if there's no such handler in this pipeline.

context

public HandlerContext context(String name)

Description copied from interface: Pipeline

Returns the context object of the Handler with the specified name in this pipeline.

Specified by:

context in interface Pipeline

Returns:

the context object of the handler with the specified name. null if there's no such handler in this pipeline.

processInbound

public CompletableFuture<Void> processInbound(Address sender,
                                              Object msg)

Description copied from interface: Pipeline

Processes an inbound message by the pipeline.

If an exception occurs during the execution of this method, the given msg is automatically released when it is of type ReferenceCounted.

Specified by:

processInbound in interface Pipeline

Parameters:

sender - the sender of the message

msg - the inbound message

processInbound

public CompletableFuture<Void> processInbound(Event event)

Description copied from interface: Pipeline

Processes an inbound event by the pipeline.

Specified by:

processInbound in interface Pipeline

Parameters:

event - the inbound event

processOutbound

public CompletableFuture<Void> processOutbound(Address recipient,
                                               Object msg)

Description copied from interface: Pipeline

Processes an outbound message by the pipeline.

If an exception occurs during the execution of this method, the given msg is automatically released when it is of type ReferenceCounted.

Specified by:

processOutbound in interface Pipeline

Parameters:

recipient - the recipient of the message

msg - the outbound message

Returns:

a completed future if the message was successfully processed, otherwise an exceptionally future