Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CommunicationBindingOptions

Defines common options of all communication binding types.

Hierarchy

Index

Properties

Optional logLevel

The level used to log errors, informational, as well as debug messages generated by the binding (optional).

Messages corresponding to the specified log level are emitted on the "error", "info", or "debug" event, respectively. If level is "error", only errors are emitted; if level is "info", only "error" and "info" messages are emitted; if level is "debug", all messages are emitted.

If not specified, the log level defaults to "error".

Optional namespace

namespace?: string

Namespace used to isolate different Coaty applications running with the same binding type in the same networking infrastructure (optional).

Communication events are only routed between agents within a common communication namespace: an agent publishes and observes communication events with respect to the given namespace.

If not specified (i.e. undefined), a default namespace named "-" is used.

Optional shouldEnableCrossNamespacing

shouldEnableCrossNamespacing?: boolean

Determines whether to enable cross-namespace communication between agents in special use cases (optional).

If true, an agent receives communication events published by any agent running with the same binding type in the same networking infrastructure, regardless of namespace.

If not specified or false, this option is not enabled.

Generated using TypeDoc