-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
-
/**
* Enumeration of worker choice strategies.
*/
/**
* Weighted round robin worker selection strategy.
*/
- WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+ WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
+ /**
+ * Interleaved weighted round robin worker selection strategy.
+ *
+ * @experimental
+ */
+ INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
} as const)
/**
*/
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
+ /**
+ * Worker weights to use for weighted round robin worker selection strategy.
+ * Weight is the tasks maximum average or median runtime in milliseconds.
+ *
+ * @defaultValue Computed worker weights automatically given the CPU performance.
+ */
+ weights?: Record<number, number>
+}
+
/**
* 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
}
/**
* Worker choice strategy interface.
*/
-export interface IWorkerChoiceStrategy<
- Worker extends IPoolWorker,
- Data = unknown,
- Response = unknown
-> {
+export interface IWorkerChoiceStrategy {
/**
- * The pool instance.
+ * Required tasks usage statistics.
*/
- readonly pool: IPoolInternal<Worker, Data, Response>
+ readonly requiredStatistics: RequiredStatistics
/**
- * Is the pool bound to the strategy dynamic?.
+ * Resets strategy internals.
+ *
+ * @returns `true` if the reset is successful, `false` otherwise.
*/
- readonly isDynamicPool: boolean
+ reset: () => boolean
/**
- * Required pool tasks usage statistics.
+ * Updates the worker node key strategy internals.
+ *
+ * @returns `true` if the update is successful, `false` otherwise.
*/
- readonly requiredStatistics: RequiredStatistics
+ update: (workerNodeKey: number) => boolean
/**
- * Resets strategy internals (counters, statistics, etc.).
+ * Chooses a worker node in the pool and returns its key.
+ *
+ * @returns The worker node key.
*/
- reset: () => boolean
+ choose: () => number
/**
- * Chooses a worker in the pool and returns its key.
+ * Removes the worker node key from strategy internals.
+ *
+ * @param workerNodeKey - The worker node key.
+ * @returns `true` if the worker node key is removed, `false` otherwise.
*/
- choose: () => number
+ remove: (workerNodeKey: number) => boolean
/**
- * Removes a worker reference from strategy internals.
+ * 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
}