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=2c6c2e16d6e4d52e7f19841e6d6f331db3d678f9;hpb=8b4d450024ef06de939fa82f9746b005696914c0;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 2c6c2e16..fa0d0f64 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -29,12 +29,36 @@ export const WorkerChoiceStrategies = Object.freeze({ */ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies +/** + * Worker choice strategy options. + */ +export interface WorkerChoiceStrategyOptions { + /** + * Use tasks median run time instead of average run time. + * + * @defaultValue false + */ + medRunTime?: boolean +} + /** * Pool worker tasks usage statistics requirements. + * + * @internal */ export interface RequiredStatistics { + /** + * Require tasks run time. + */ runTime: boolean + /** + * Require tasks average run time. + */ avgRunTime: boolean + /** + * Require tasks median run time. + */ + medRunTime: boolean } /** @@ -42,7 +66,7 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required pool tasks usage statistics. + * Required tasks usage statistics. */ readonly requiredStatistics: RequiredStatistics /** @@ -50,13 +74,19 @@ export interface IWorkerChoiceStrategy { */ reset: () => boolean /** - * Chooses a worker in the pool and returns its key. + * Chooses a worker node in the pool and returns its key. */ choose: () => number /** - * Removes a worker reference from strategy internals. + * 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 workerKey - The worker key. + * @param opts - The worker choice strategy options. */ - remove: (workerKey: number) => boolean + setOptions: (opts: WorkerChoiceStrategyOptions) => void }