feat: add pool runtime setters
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
CommitLineData
bbeadd16 1import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
c4855468 2import { PoolType, type IPool } from '../pool'
f06e48d8 3import type { IWorker } from '../worker'
10fcfaf4
JB
4import type {
5 IWorkerChoiceStrategy,
da309861
JB
6 RequiredStatistics,
7 WorkerChoiceStrategyOptions
10fcfaf4 8} from './selection-strategies-types'
bdaf31cd
JB
9
10/**
9cd39dd4 11 * Worker choice strategy abstract base class.
bdaf31cd 12 *
38e795c1
JB
13 * @typeParam Worker - Type of worker which manages the strategy.
14 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
02706357 15 * @typeParam Response - Type of execution response. This can only be serializable data.
bdaf31cd
JB
16 */
17export abstract class AbstractWorkerChoiceStrategy<
f06e48d8 18 Worker extends IWorker,
b2b1d84e
JB
19 Data = unknown,
20 Response = unknown
17393ac8 21> implements IWorkerChoiceStrategy {
afc003b2 22 /** @inheritDoc */
8b4d4500 23 protected readonly isDynamicPool: boolean
afc003b2 24 /** @inheritDoc */
da309861 25 public readonly requiredStatistics: RequiredStatistics = {
c6bd2650 26 runTime: false,
78099a15
JB
27 avgRunTime: false,
28 medRunTime: false
10fcfaf4 29 }
bdaf31cd
JB
30
31 /**
6533c3e6 32 * Constructs a worker choice strategy bound to the pool.
bdaf31cd 33 *
38e795c1 34 * @param pool - The pool instance.
da309861 35 * @param opts - The worker choice strategy options.
bdaf31cd
JB
36 */
37 public constructor (
c4855468 38 protected readonly pool: IPool<Worker, Data, Response>,
a20f0ba5 39 protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
b8f3418c
JB
40 ) {
41 this.isDynamicPool = this.pool.type === PoolType.DYNAMIC
1086026a 42 this.choose.bind(this)
b8f3418c 43 }
bdaf31cd 44
2fc5cae3 45 protected checkOptions (opts: WorkerChoiceStrategyOptions): void {
f9f00b5f 46 if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
2fc5cae3
JB
47 this.requiredStatistics.avgRunTime = false
48 this.requiredStatistics.medRunTime = opts.medRunTime as boolean
da309861 49 }
a20f0ba5
JB
50 if (this.requiredStatistics.medRunTime && opts.medRunTime === false) {
51 this.requiredStatistics.avgRunTime = true
52 this.requiredStatistics.medRunTime = opts.medRunTime as boolean
53 }
da309861
JB
54 }
55
afc003b2 56 /** @inheritDoc */
a6f7f1b4 57 public abstract reset (): boolean
ea7a90d3 58
afc003b2 59 /** @inheritDoc */
c923ce56 60 public abstract choose (): number
97a2abc3 61
afc003b2 62 /** @inheritDoc */
f06e48d8 63 public abstract remove (workerNodeKey: number): boolean
a20f0ba5
JB
64
65 /** @inheritDoc */
66 public setOptions (opts: WorkerChoiceStrategyOptions): void {
67 this.checkOptions(opts)
68 this.opts = opts
69 }
bdaf31cd 70}