types.nope.ICommunicationBridge

A ICommunicationBridge is used to establish different connections (a bridge can establish several connections with different layers).

The ICommunicationBridge is the core interface with which all Nope core elements interact. Its main task is to add and remove multiple layers (like 'mqtt' or 'io-sockets'; see ICommunicationInterface)

To the outside, the bridge behaves like a ICommunicationInterface. I.e. the methods on and emit are also implemented. However, the bridge ensures that each of the ICommunicationInterface added, are able to receive and send the messages. Furthermore the status connected indicates whether all layers are connected or not.

If different layers are only optional, e.g. all connections are covered by io-sockets, but all messages are to be mirrored to MQTT because they are to be picked up there, then this can be taken into account in the add method. These connections are then not taken into account in the connected status.

Export

ICommunicationBridge

• ICommunicationInterface

  ↳ ICommunicationBridge

• Bridge

Readonly connected: INopeObservable<boolean, boolean, boolean, IEventAdditionalData>

Flag, indication, whether the Layer is connected or not.

ICommunicationInterface.connected

---

Readonly id: string

ID of the Layer.

Author

M.Karkowski

Memberof

ICommunicationInterface

ICommunicationInterface.id

---

Readonly receivesOwnMessages: boolean

Used to show, whether the the layer receives its own messages

Memberof

ICommunicationInterface

ICommunicationInterface.receivesOwnMessages

addCommunicationLayer(layer, forwardData?, considerConnection?): Promise<void>

Function, to add an Layer to the Bridge

Memberof

ICommunicationBridge

Name	Type	Description
layer	ICommunicationInterface	The Layer to Add.
forwardData?	boolean	-
considerConnection?	boolean	Flag, that enables considering this flag in the connected flag.

Promise<void>

---

Optional detailListeners(type, listeners): any

Helper to detail the listeners of the "event", "rpc", "data" or "responses"

Name	Type	Description
type	"event" | "rpc" | "data" | "response"	valid type to detail the name
listeners	string[]	the currently used listeners.

any

ICommunicationInterface.detailListeners

---

dispose(): Promise<void>

Disconnect the Layer.

Memberof

ICommunicationInterface

Promise<void>

{Promise}

ICommunicationInterface.dispose

---

emit<T>(eventname, data): Promise<void>

used to emit some data on the bride. It will distribute the event accors

Author

M.Karkowski

Memberof

ICommunicationInterface

Name	Type
T	extends keyof EventnameToEventType

Name	Type
eventname	T
data	EventnameToEventType[T] & IExtraData

Promise<void>

{Promise}

ICommunicationInterface.emit

---

on<T>(eventname, cb): Promise<void>

used to emit some data.

Author

M.Karkowski

Memberof

ICommunicationInterface

Name	Type
T	extends keyof EventnameToEventType

Name	Type	Description
eventname	T	The Event name
cb	(data: EventnameToEventType[T] & IExtraData) => void	The Callback to use.

Promise<void>

ICommunicationInterface.on

---

removeCommunicationLayer(layer): Promise<void>

Function, to remove the Layer again. Data wont be forwarded any more.

Memberof

ICommunicationBridge

Name	Type	Description
layer	ICommunicationInterface	The Layer to Remove

Promise<void>

---

toDescription(): Object

Readable status of the Connection.

Memberof

ICommunicationBridge

Object

The Statsus

Name	Type
connected	boolean
layers	{ considerConnection: boolean ; forwardData: boolean ; id: string ; receivesOwnMessages: boolean }[]