X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=065b310fa5e8a3454f84d5b0edd6324c7c2d0520;hb=23d03397abcbf7274ba08acf89728bcaf32f0f6f;hp=9ae6676550be28564a12eae35f6e64ce15db640d;hpb=168c526f6e6913506e56f7d5107335c3d3d42938;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 9ae66765..065b310f 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. */ @@ -32,24 +30,41 @@ 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. + */ + 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 /** @@ -57,7 +72,13 @@ 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. */ - choose: () => Worker + remove: (workerNodeKey: number) => boolean }