X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=f9a504351a4bbbe9d33bddc145c457a7ce27ef78;hb=a20f0ba5aa9c6946254aa197286ad9b70b6a0319;hp=dd545d41f590acdeada321782ee23fc51606168f;hpb=23ff945ac0bc3b9bcf98c6491872cffaac805b73;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index dd545d41..f9a50435 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -1,5 +1,3 @@ -import type { AbstractPoolWorker } from '../abstract-pool-worker' - /** * Enumeration of worker choice strategies. */ @@ -9,9 +7,13 @@ export const WorkerChoiceStrategies = Object.freeze({ */ ROUND_ROBIN: 'ROUND_ROBIN', /** - * Less recently used worker selection strategy. + * Less used worker selection strategy. + */ + LESS_USED: 'LESS_USED', + /** + * Less busy worker selection strategy. */ - LESS_RECENTLY_USED: 'LESS_RECENTLY_USED', + LESS_BUSY: 'LESS_BUSY', /** * Fair share worker selection strategy. */ @@ -28,17 +30,61 @@ export const WorkerChoiceStrategies = Object.freeze({ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies /** - * Worker choice strategy interface. + * Worker choice strategy options. + */ +export interface WorkerChoiceStrategyOptions { + /** + * Use tasks median run time instead of average run time. + */ + medRunTime?: boolean +} + +/** + * Pool worker tasks usage statistics requirements. * - * @template Worker Type of worker which manages the strategy. + * @internal */ -export interface IWorkerChoiceStrategy { +export interface RequiredStatistics { + /** + * Require tasks run time. + */ + runTime: boolean + /** + * Require tasks average run time. + */ + avgRunTime: boolean + /** + * Require tasks median run time. + */ + medRunTime: boolean +} + +/** + * Worker choice strategy interface. + */ +export interface IWorkerChoiceStrategy { + /** + * Required tasks usage statistics. + */ + readonly requiredStatistics: RequiredStatistics + /** + * Resets strategy internals (counters, statistics, etc.). + */ + reset: () => boolean + /** + * Chooses a worker node in the pool and returns its key. + */ + choose: () => number /** - * Is the pool attached to the strategy dynamic?. + * Removes a worker node key from strategy internals. + * + * @param workerNodeKey - The worker node key. */ - isDynamicPool: boolean + remove: (workerNodeKey: number) => boolean /** - * Choose a worker in the pool. + * Sets the worker choice strategy options. + * + * @param opts - The worker choice strategy options. */ - choose(): Worker + setOptions: (opts: WorkerChoiceStrategyOptions) => void }