X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=137c1be7562e50309818763f556651aed2034b04;hb=6533c3e6b6a95daade8d20577d6b816512e2aeeb;hp=edefcfaac429d8c0d24fa897300650d141ab7f3c;hpb=bdaf31cd0e637aa466c78d54a49f157899a2cb3f;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index edefcfaa..137c1be7 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -1,4 +1,5 @@ -import type { AbstractPoolWorker } from '../abstract-pool-worker' +import type { IPoolInternal } from '../pool-internal' +import type { IPoolWorker } from '../pool-worker' /** * Enumeration of worker choice strategies. @@ -9,9 +10,21 @@ export const WorkerChoiceStrategies = Object.freeze({ */ ROUND_ROBIN: 'ROUND_ROBIN', /** - * Less recently used worker selection strategy. + * Less used worker selection strategy. */ - LESS_RECENTLY_USED: 'LESS_RECENTLY_USED' + LESS_USED: 'LESS_USED', + /** + * Less busy worker selection strategy. + */ + LESS_BUSY: 'LESS_BUSY', + /** + * Fair share worker selection strategy. + */ + FAIR_SHARE: 'FAIR_SHARE', + /** + * Weighted round robin worker selection strategy. + */ + WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN' } as const) /** @@ -19,18 +32,46 @@ export const WorkerChoiceStrategies = Object.freeze({ */ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies +/** + * Pool worker tasks usage statistics requirements. + */ +export interface RequiredStatistics { + runTime: boolean + avgRunTime: boolean +} + /** * Worker choice strategy interface. - * - * @template Worker Type of worker which manages the strategy. */ -export interface IWorkerChoiceStrategy { +export interface IWorkerChoiceStrategy< + Worker extends IPoolWorker, + Data = unknown, + Response = unknown +> { + /** + * The pool instance. + */ + readonly pool: IPoolInternal + /** + * Is the pool bound to the strategy dynamic?. + */ + readonly isDynamicPool: boolean + /** + * Required pool tasks usage statistics. + */ + readonly requiredStatistics: RequiredStatistics + /** + * Resets strategy internals (counters, statistics, etc.). + */ + reset: () => boolean /** - * Is the pool attached to the strategy dynamic?. + * Chooses a worker in the pool and returns its key. */ - isDynamicPool: boolean + choose: () => number /** - * Choose a worker in the pool. + * Removes a worker reference from strategy internals. + * + * @param workerKey - The worker key. */ - choose(): Worker + remove: (workerKey: number) => boolean }