dispatcher.baseServices - ZeMA-gGmbH/NoPE-JS GitHub Wiki
dispatcher.baseServices
Const SERVICES_NAME: Object
Helper to define simpler names for the Services
| 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> }> |
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
| Name | Type | Description |
|---|---|---|
dispatcher |
INopeDispatcher |
The Dispatcher to use. |
opts? |
Object |
|
opts.services? |
("defineMaster" | "pingService" | "timeSyncingService" | "syncingDataService")[] |
- |
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(dispatcher): Promise<{}>
Generate and registers a ping service.
Author
M.Karkowski
Export
| Name | Type |
|---|---|
dispatcher |
INopeDispatcher |
Promise<{}>
The function to ping all dispatchers.
generateDefineMaster(dispatcher): Promise<{ setMaster: () => Promise<void> }>
A Helper to create a Service to manually define a master.
Author
M.Karkowski
Export
| Name | Type | Description |
|---|---|---|
dispatcher |
INopeDispatcher |
The Dispatcher to use. |
Promise<{ setMaster: () => Promise<void> }>
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
| Name | Type |
|---|---|
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 }[] }> }>
The function to ping all dispatchers.
generateSyncServices(dispatcher): Promise<{ manualSyncTime: () => Promise<void> }>
Registers a sync service, which will syncronize the time
Author
M.Karkowski
Export
| Name | Type |
|---|---|
dispatcher |
INopeDispatcher |
Promise<{ manualSyncTime: () => Promise<void> }>
The Sync-Method to call
waitForDispatcher(dispatcher, name): Promise<{}>
Helper, that lets enables waiting for a required dispatcher.
Author
M.Karkowski
Export
| Name | Type |
|---|---|
dispatcher |
INopeDispatcher |
name |
string |
Promise<{}>