Commit | Line | Data |
---|---|---|
bdaf31cd JB |
1 | /** |
2 | * Enumeration of worker choice strategies. | |
3 | */ | |
4 | export const WorkerChoiceStrategies = Object.freeze({ | |
5 | /** | |
6 | * Round robin worker selection strategy. | |
7 | */ | |
8 | ROUND_ROBIN: 'ROUND_ROBIN', | |
9 | /** | |
737c6d97 | 10 | * Less used worker selection strategy. |
bdaf31cd | 11 | */ |
737c6d97 | 12 | LESS_USED: 'LESS_USED', |
168c526f JB |
13 | /** |
14 | * Less busy worker selection strategy. | |
15 | */ | |
16 | LESS_BUSY: 'LESS_BUSY', | |
23ff945a JB |
17 | /** |
18 | * Fair share worker selection strategy. | |
19 | */ | |
20 | FAIR_SHARE: 'FAIR_SHARE', | |
b3432a63 JB |
21 | /** |
22 | * Weighted round robin worker selection strategy. | |
23 | */ | |
24 | WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN' | |
bdaf31cd JB |
25 | } as const) |
26 | ||
27 | /** | |
28 | * Worker choice strategy. | |
29 | */ | |
30 | export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies | |
31 | ||
ff733df7 JB |
32 | /** |
33 | * Worker choice strategy options. | |
34 | */ | |
35 | export interface WorkerChoiceStrategyOptions { | |
b0623665 JB |
36 | /** |
37 | * Use tasks median run time instead of average run time. | |
38 | */ | |
ff733df7 JB |
39 | medRunTime?: boolean |
40 | } | |
41 | ||
10fcfaf4 | 42 | /** |
9cd39dd4 | 43 | * Pool worker tasks usage statistics requirements. |
10fcfaf4 | 44 | */ |
78cea37e | 45 | export interface RequiredStatistics { |
243a550a JB |
46 | /** |
47 | * Require tasks run time. | |
48 | */ | |
10fcfaf4 | 49 | runTime: boolean |
243a550a JB |
50 | /** |
51 | * Require tasks average run time. | |
52 | */ | |
c6bd2650 | 53 | avgRunTime: boolean |
243a550a JB |
54 | /** |
55 | * Require tasks median run time. | |
56 | */ | |
78099a15 | 57 | medRunTime: boolean |
10fcfaf4 JB |
58 | } |
59 | ||
bdaf31cd JB |
60 | /** |
61 | * Worker choice strategy interface. | |
bdaf31cd | 62 | */ |
17393ac8 | 63 | export interface IWorkerChoiceStrategy { |
10fcfaf4 | 64 | /** |
f06e48d8 | 65 | * Required tasks usage statistics. |
10fcfaf4 | 66 | */ |
ea7a90d3 JB |
67 | readonly requiredStatistics: RequiredStatistics |
68 | /** | |
a6f7f1b4 | 69 | * Resets strategy internals (counters, statistics, etc.). |
ea7a90d3 | 70 | */ |
78cea37e | 71 | reset: () => boolean |
bdaf31cd | 72 | /** |
f06e48d8 | 73 | * Chooses a worker node in the pool and returns its key. |
bdaf31cd | 74 | */ |
c923ce56 | 75 | choose: () => number |
97a2abc3 | 76 | /** |
f06e48d8 | 77 | * Removes a worker node key from strategy internals. |
97a2abc3 | 78 | * |
f06e48d8 | 79 | * @param workerNodeKey - The worker node key. |
97a2abc3 | 80 | */ |
f06e48d8 | 81 | remove: (workerNodeKey: number) => boolean |
bdaf31cd | 82 | } |