Class NopeConnectivityManager

A Modul to manage the status of other statusmanagers. Dispatcher should have a status manager, to ensure, the system is online etc. Its a base implemetation of the INopeConnectivityManager. Please checkout the interface for more details or the corresponding jupyter notebook.

Author

M.Karkowski

Export

Implements

Hierarchy

NopeConnectivityManager

Implements

INopeConnectivityManager

Index

Constructors

constructor

new NopeConnectivityManager(options, _generateObservable, id?): NopeConnectivityManager
Creates an instance of NopeConnectivityManager.

Author
M.Karkowski

Memberof
NopeConnectivityManager
Parameters
- options: INopeINopeConnectivityOptions
  
  The Options, used by the Manager.
- _generateObservable: (<T>() => INopeObservable<T, T, T, IEventAdditionalData>)
  
  A Helper, to generate Observables.
  - - <T>(): INopeObservable<T, T, T, IEventAdditionalData>
    - Type Parameters
      
      T
      
      Returns INopeObservable<T, T, T, IEventAdditionalData>
- Optional id: string = null
  
  specific id. Otherwise a ID is generated
Returns NopeConnectivityManager
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:204

Properties

`Readonly` dispatchers

dispatchers: IMapBasedMergeData<string, INopeStatusInfo, string, string>

Mapping for the External Dispatchers. You can use the Event, onChange, to get the latest changes. Use the "data" field, to subscribe for the latest data.

OriginalKey = Dispatcher ID`
OriginalValue = INopeStatusInfo
ExtractedKey = Dispatcher ID
ExtractedValue = Dispatcher ID

Author

M.Karkowski

Memberof

INopeStatusManager

`Readonly` id

id: string = null

specific id. Otherwise a ID is generated

options

options: INopeINopeConnectivityOptions

The Options, used by the Manager.

`Readonly` ready

ready: INopeObservable<boolean, boolean, boolean, IEventAdditionalData>

Flag, to show, that the System is ready

Author

M.Karkowski

Memberof

INopeStatusManager

Accessors

connectedSince

get connectedSince(): number
see connectedSince

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns number
Implementation of INopeConnectivityManager.connectedSince
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:276

info

get info(): INopeStatusInfo
see info

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns INopeStatusInfo
Implementation of INopeConnectivityManager.info
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:110

isMaster

get isMaster(): boolean
see isMaster

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns boolean
Implementation of INopeConnectivityManager.isMaster
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:309
set isMaster(value): void
see isMaster

Author
M.Karkowski

Memberof
NopeConnectivityManager
Parameters
- value: boolean
Returns void
Implementation of INopeConnectivityManager.isMaster
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:296

master

get master(): INopeStatusInfo
see master

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns INopeStatusInfo
Implementation of INopeConnectivityManager.master
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:346

now

get now(): number
see now

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns number
Implementation of INopeConnectivityManager.now
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:377

upTime

get upTime(): number
see upTime

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns number
Implementation of INopeConnectivityManager.upTime
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:264

Methods

dispose

dispose(quiet?): Promise<void>
Will dispose the Dispatcher. Must be called on exit for a clean exit. Otherwise it is defined as dirty exits
Parameters
- quiet: boolean = false
Returns Promise<void>
Implementation of INopeConnectivityManager.dispose
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:719

emitBonjour

emitBonjour(): Promise<void>
see emitBonjour

Author
M.Karkowski

Returns

Memberof
NopeConnectivityManager

Returns Promise<void>
Implementation of INopeConnectivityManager.emitBonjour
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:601

getAllHosts

getAllHosts(): string[]
see getAllHosts

Author
M.Karkowski

Returns
{string[]}

Memberof
NopeConnectivityManager

Returns string[]
Implementation of INopeConnectivityManager.getAllHosts
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:707

getStatus

getStatus(id): INopeStatusInfo
see getStatus

Author
M.Karkowski

Returns

Memberof
NopeConnectivityManager
Parameters
- id: string
Returns INopeStatusInfo
Implementation of INopeConnectivityManager.getStatus
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:590

reset

reset(): void
see reset

Author
M.Karkowski

Memberof
NopeConnectivityManager

Returns void
Implementation of INopeConnectivityManager.reset
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:612

setTimings

setTimings(options): void
see setTimings

Author
M.Karkowski

Memberof
NopeConnectivityManager
Parameters
- options: Partial<INopeINopeConnectivityTimeOptions>
Returns void
Implementation of INopeConnectivityManager.setTimings
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:624

syncTime

syncTime(timestamp, delay?): void
see syncTime

Author
M.Karkowski

Memberof
NopeConnectivityManager
Parameters
- timestamp: number
- Optional delay: number = 0
Returns void
Implementation of INopeConnectivityManager.syncTime
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:577

toDescription

toDescription(): {
dispatchers: string[];
}
Describes the Data.

Returns

Returns {
dispatchers: string[];
}
- dispatchers: string[]
Implementation of INopeConnectivityManager.toDescription
- Defined in lib/dispatcher/ConnectivityManager/ConnectivityManager.ts:740

Class NopeConnectivityManager

Author

Export

Implements

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Author

Memberof

Parameters

options: INopeINopeConnectivityOptions

_generateObservable: (<T>() => INopeObservable<T, T, T, IEventAdditionalData>)

Type Parameters

T

Returns INopeObservable<T, T, T, IEventAdditionalData>

Optional id: string = null

Returns NopeConnectivityManager

Properties

Readonly dispatchers

Author

Memberof

Readonly id

options

Readonly ready

Author

Memberof

Accessors

connectedSince

Author

Memberof

Returns number

info

Author

Memberof

Returns INopeStatusInfo

isMaster

Author

Memberof

Returns boolean

Author

Memberof

Parameters

value: boolean

Returns void

master

Author

Memberof

Returns INopeStatusInfo

now

Author

Memberof

Returns number

upTime

Author

Memberof

Returns number

Methods

dispose

Parameters

quiet: boolean = false

Returns Promise<void>

emitBonjour

Author

Returns

Memberof

Returns Promise<void>

getAllHosts

Author

Returns

Memberof

Returns string[]

getStatus

Author

Returns

`Optional` id: string = null

`Readonly` dispatchers

`Readonly` id

`Readonly` ready

`Optional` delay: number = 0

Returns {
dispatchers: string[];
}