dispatcher.baseServices - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Namespace: baseServices

dispatcher.baseServices

Variables

SERVICES_NAME

Const SERVICES_NAME: Object

Helper to define simpler names for the Services

Type declaration

Name Type
defineMaster (dispatcher: INopeDispatcher) => Promise<{ setMaster: () => Promise<void> }>
pingService (dispatcher: INopeDispatcher) => Promise<{ determinePing: (target: string) => Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }> ; pingAll: () => Promise<{ avg: number ; max: { index: number ; max: number } ; min: { index: number ; min: number } ; pings: { dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }[] }> }>
syncingDataService (dispatcher: INopeDispatcher) => Promise<{}>
timeSyncingService (dispatcher: INopeDispatcher) => Promise<{ manualSyncTime: () => Promise<void> }>

Functions

addAllBaseServices

addAllBaseServices(dispatcher, opts?): Promise<{ determinePing?: (target: string) => Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }> ; manualSyncTime?: () => Promise<void> ; pingAll?: () => Promise<{ avg: number ; max: { index: number ; max: number } ; min: { index: number ; min: number } ; pings: Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }>[] }> ; setMaster?: () => Promise<void> }>

Helper, which will enable all BaseServices

Author

M.Karkowski

Export

Parameters

Name Type Description
dispatcher INopeDispatcher The Dispatcher to use.
opts? Object
opts.services? ("defineMaster" | "pingService" | "timeSyncingService" | "syncingDataService")[] -

Returns

Promise<{ determinePing?: (target: string) => Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }> ; manualSyncTime?: () => Promise<void> ; pingAll?: () => Promise<{ avg: number ; max: { index: number ; max: number } ; min: { index: number ; min: number } ; pings: Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }>[] }> ; setMaster?: () => Promise<void> }>

The provided Functions.


enablingSyncingData

enablingSyncingData(dispatcher): Promise<{}>

Generate and registers a ping service.

Author

M.Karkowski

Export

Parameters

Name Type
dispatcher INopeDispatcher

Returns

Promise<{}>

The function to ping all dispatchers.


generateDefineMaster

generateDefineMaster(dispatcher): Promise<{ setMaster: () => Promise<void> }>

A Helper to create a Service to manually define a master.

Author

M.Karkowski

Export

Parameters

Name Type Description
dispatcher INopeDispatcher The Dispatcher to use.

Returns

Promise<{ setMaster: () => Promise<void> }>


generatePingServices

generatePingServices(dispatcher): Promise<{ determinePing: (target: string) => Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }> ; pingAll: () => Promise<{ avg: number ; max: { index: number ; max: number } ; min: { index: number ; min: number } ; pings: { dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }[] }> }>

Generate and registers a ping service.

Author

M.Karkowski

Export

Parameters

Name Type
dispatcher INopeDispatcher

Returns

Promise<{ determinePing: (target: string) => Promise<{ dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }> ; pingAll: () => Promise<{ avg: number ; max: { index: number ; max: number } ; min: { index: number ; min: number } ; pings: { dispatcherId: string ; isMaster: boolean ; ping: number ; requestId: string ; timestamp: number }[] }> }>

The function to ping all dispatchers.


generateSyncServices

generateSyncServices(dispatcher): Promise<{ manualSyncTime: () => Promise<void> }>

Registers a sync service, which will syncronize the time

Author

M.Karkowski

Export

Parameters

Name Type
dispatcher INopeDispatcher

Returns

Promise<{ manualSyncTime: () => Promise<void> }>

The Sync-Method to call


waitForDispatcher

waitForDispatcher(dispatcher, name): Promise<{}>

Helper, that lets enables waiting for a required dispatcher.

Author

M.Karkowski

Export

Parameters

Name Type
dispatcher INopeDispatcher
name string

Returns

Promise<{}>

⚠️ **GitHub.com Fallback** ⚠️