core/it.unibo.pulvreakt.api.component.pulverization/Communication

Communication

abstract class Communication<Comm : Any>(serializer: KSerializer<CommunicationPayload<Comm>>) : AbstractPulverizedComponent

Represents the Communication component in the pulverization model.

The communication component is used to send and receive messages from the other devices.

Constructors

Communication

constructor(serializer: KSerializer<CommunicationPayload<Comm>>)

Properties

open lateinit override var di: DI

diContext

open val diContext: DIContext<*>

diTrigger

open val diTrigger: DITrigger?

Functions

execute

open suspend override fun execute(): Either<ComponentError, Unit>

Starts the execution of the component logic. The execution may fail with a ComponentError. Before calling this method the setupWiring method MUST be called.

finalize

open suspend override fun finalize(): Either<ComponentError, Unit>

Asynchronously finalizes the entity. Can Either succeed or fail with an Error.

getRef

override fun getRef(): ComponentRef

Returns a symbolic reference to this component. This method is used internally by the runtime and should not be called by the user.

initialize

open suspend override fun initialize(): Either<ComponentError, Unit>

Asynchronously initializes the entity. Can Either succeed or fail with an Error.

receive

suspend override fun receive(fromComponent: ComponentRef, serializer: KSerializer<out P>): Either<ComponentError, Flow>

Receives a message of type P by deserializing it with the given serializer. If the message pushed in the flow cannot be serialized with the given serializer the flow will fail with an exception. This method can fail with a ComponentNotRegistered if the fromComponent is not registered as link of this component.

abstract suspend fun receive(): Flow<CommunicationPayload<Comm>>

Receives the communication from the other linked devices.

receive

inline suspend fun Component.receive(fromComponent: ComponentRef): Either<ComponentError, Flow>

Helper method to receive messages fromComponent without specifying the serialization.

send

suspend override fun send(toComponent: ComponentRef, message: P, serializer: KSerializer<in P>): Either<ComponentError, Unit>

Sends a message of type P by serializing it with the given serializer. This method can fail with a ComponentNotRegistered if the toComponent is not registered as link of this component.

abstract suspend fun send(message: CommunicationPayload<Comm>)

Sends to the other linked devices the given message.

send

inline suspend fun Component.send(toComponent: ComponentRef, message: P): Either<ComponentError, Unit>

Helper method to send a message without specifying the serialization.

setupInjector

open override fun setupInjector(kodein: DI)

Configures the module of the dependency injection module that the resource will use.

setupWiring

open override fun setupWiring(vararg components: ComponentRef)

Setup all the other components to which this component will communicate. The components represents the symbolic references to the other components allowing a distributed communication. This method is generally called by the runtime when the pulverization model is adopted. In case of custom Logical Device partitioning this method should be called manually.