X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=fa0d0f641a4b8618efa7346a3ba4029a93bc533b;hb=feec4213515cceb460e722dedca403914764b487;hp=3e7c3427e84f7bedb015e8f6d7ef54215377bd40;hpb=38e795c12f0e9daeff7b025147f36f85f486366e;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 3e7c3427..fa0d0f64 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 { IPoolWorker } from '../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,24 +30,43 @@ export const WorkerChoiceStrategies = Object.freeze({ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies /** - * Pool tasks usage statistics requirements. + * Worker choice strategy options. */ -export interface RequiredStatistics { - runTime: boolean +export interface WorkerChoiceStrategyOptions { + /** + * Use tasks median run time instead of average run time. + * + * @defaultValue false + */ + medRunTime?: boolean } /** - * Worker choice strategy interface. + * Pool worker tasks usage statistics requirements. * - * @typeParam Worker - Type of worker which manages the strategy. + * @internal */ -export interface IWorkerChoiceStrategy { +export interface RequiredStatistics { + /** + * Require tasks run time. + */ + runTime: boolean /** - * Is the pool attached to the strategy dynamic?. + * Require tasks average run time. */ - readonly isDynamicPool: boolean + avgRunTime: boolean /** - * Required pool tasks usage statistics. + * Require tasks median run time. + */ + medRunTime: boolean +} + +/** + * Worker choice strategy interface. + */ +export interface IWorkerChoiceStrategy { + /** + * Required tasks usage statistics. */ readonly requiredStatistics: RequiredStatistics /** @@ -53,7 +74,19 @@ export interface IWorkerChoiceStrategy { */ reset: () => boolean /** - * Chooses a worker in the pool. + * Chooses a worker node in the pool and returns its key. + */ + choose: () => number + /** + * Removes a worker node key from strategy internals. + * + * @param workerNodeKey - The worker node key. + */ + remove: (workerNodeKey: number) => boolean + /** + * Sets the worker choice strategy options. + * + * @param opts - The worker choice strategy options. */ - choose: () => Worker + setOptions: (opts: WorkerChoiceStrategyOptions) => void }