Class EventCommunicationInterface

A Basic Mirror, used to share the events in a Mirror Style. This Layer should not be used directly. this should only be extended.

Export

Implements

Hierarchy

EventCommunicationInterface
- ioSocketServerLayer
- IoSocketClientLayer

Implements

ICommunicationInterface

Index

Constructors

Properties

connected id receivesOwnMessages

Methods

detailListeners dispose emit on

Constructors

constructor

new EventCommunicationInterface(_emitter?, _logger?, receivesOwnMessages?): EventCommunicationInterface
Creates an instance of EventMirror.

Memberof
EventMirror
Parameters
- Optional _emitter: IEmitter = ...
- Optional _logger: ILogger
  
  a Logger
- receivesOwnMessages: boolean = true
Returns EventCommunicationInterface
- Defined in lib/communication/layers/EventCommunicationInterface.ts:83

Properties

connected

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

Flag, showing whether the Mirror is connected or not.

Memberof

EventMirror

id

id: string

ID of the Layer.

Author

M.Karkowski

Memberof

ICommunicationInterface

`Readonly` receivesOwnMessages

receivesOwnMessages: boolean = true

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

Memberof

ICommunicationInterface

Methods

detailListeners

detailListeners(type, listeners): void
Helper to detail the listeners of the "event", "rpc", "data" or "responses"
Parameters
- type: "event" | "rpc" | "data" | "response"
  
  valid type to detail the name
- listeners: string[]
  
  the currently used listeners.
Returns void
Implementation of ICommunicationInterface.detailListeners
- Defined in lib/communication/layers/EventCommunicationInterface.ts:93

dispose

dispose(): Promise<void>
Disconnect the Layer.

Returns

Memberof
ICommunicationInterface

Returns Promise<void>
Implementation of ICommunicationInterface.dispose
- Defined in lib/communication/layers/EventCommunicationInterface.ts:72

emit

emit<T>(eventname, data): Promise<void>
Function, which will be used to emit data

Memberof
EventMirror
Type Parameters
- T extends keyof EventnameToEventType
Parameters
- eventname: T
- data: EventnameToEventType[T]
  
  the data to emit
Returns Promise<void>
Implementation of ICommunicationInterface.emit
- Defined in lib/communication/layers/EventCommunicationInterface.ts:57

on

on<T>(eventname, cb): Promise<void>
Function which will be used to subscribe Data

Memberof
EventMirror
Type Parameters
- T extends keyof EventnameToEventType
Parameters
- eventname: T
- cb: ((data) => void)
  - - (data): void
    - Parameters
      
      data: EventnameToEventType[T]
      
      Returns void
Returns Promise<void>
Implementation of ICommunicationInterface.on
- Defined in lib/communication/layers/EventCommunicationInterface.ts:38

Generated using TypeDoc