X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=137c1be7562e50309818763f556651aed2034b04;hb=6533c3e6b6a95daade8d20577d6b816512e2aeeb;hp=21e4129eeca6d9e09619647ab7b80abbd299032c;hpb=78cea37e264d5ca527bc42eb056f3b9579a2b2c4;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 21e4129e..137c1be7 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -1,3 +1,4 @@ +import type { IPoolInternal } from '../pool-internal' import type { IPoolWorker } from '../pool-worker' /** @@ -9,9 +10,13 @@ export const WorkerChoiceStrategies = Object.freeze({ */ ROUND_ROBIN: 'ROUND_ROBIN', /** - * Less recently used worker selection strategy. + * Less used worker selection strategy. */ - LESS_RECENTLY_USED: 'LESS_RECENTLY_USED', + LESS_USED: 'LESS_USED', + /** + * Less busy worker selection strategy. + */ + LESS_BUSY: 'LESS_BUSY', /** * Fair share worker selection strategy. */ @@ -28,20 +33,27 @@ export const WorkerChoiceStrategies = Object.freeze({ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies /** - * Pool tasks usage statistics requirements. + * Pool worker tasks usage statistics requirements. */ export interface RequiredStatistics { runTime: boolean + avgRunTime: boolean } /** * Worker choice strategy interface. - * - * @template Worker Type of worker which manages the strategy. */ -export interface IWorkerChoiceStrategy { +export interface IWorkerChoiceStrategy< + Worker extends IPoolWorker, + Data = unknown, + Response = unknown +> { + /** + * The pool instance. + */ + readonly pool: IPoolInternal /** - * Is the pool attached to the strategy dynamic?. + * Is the pool bound to the strategy dynamic?. */ readonly isDynamicPool: boolean /** @@ -53,7 +65,13 @@ export interface IWorkerChoiceStrategy { */ reset: () => boolean /** - * Chooses a worker in the pool. + * Chooses a worker in the pool and returns its key. + */ + choose: () => number + /** + * Removes a worker reference from strategy internals. + * + * @param workerKey - The worker key. */ - choose: () => Worker + remove: (workerKey: number) => boolean }