CommunicationBindingJoinOptions | @coaty/core

Defines options for joining the Coaty communication infrastructure.

Hierarchy

CommunicationBindingJoinOptions

Index

Properties

agentId

agentId: string

An id that uniquely identifies the joining agent.

A binding might use this id e.g. as a client or session id for the underlying messaging transport.

joinEvents

joinEvents: CommunicationEventLike[]

One-way communication event likes to be published to subscribing agents whenever this binding joins or rejoins the Coaty communication infrastructure.

On joining, these events must always be published first, before any other pending events.

remarks: These events must also be republished after temporary disconnections in a broker-based communication infrastructure.

unjoinEvent

unjoinEvent: CommunicationEventLike

A one-way communication event like that must be delivered to subscribing agents whenever this binding unjoins the Coaty communication infrastructure expectedly or unexpectedly.

remarks: The event must not only be delivered when the unjoin method is called; it must also be delivered whenever this binding (temporarily) becomes offline, e.g. if the underlying messaging transport is destroyed abnormally or if the agent process is terminated abnormally.