X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=fa0d0f641a4b8618efa7346a3ba4029a93bc533b;hb=2092c35fc1873fb746244f15af3478e246bb4b3b;hp=a05fd9b784c9da682cd0e270f09b81ce41325d70;hpb=c923ce5670eeae4194aa996d44a1071e88cb21ad;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index a05fd9b7..fa0d0f64 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -30,10 +30,35 @@ export const WorkerChoiceStrategies = Object.freeze({ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies /** - * Pool tasks usage statistics requirements. + * 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 } /** @@ -41,11 +66,7 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Is the pool attached to the strategy dynamic?. - */ - readonly isDynamicPool: boolean - /** - * Required pool tasks usage statistics. + * Required tasks usage statistics. */ readonly requiredStatistics: RequiredStatistics /** @@ -53,7 +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 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. + */ + setOptions: (opts: WorkerChoiceStrategyOptions) => void }