/**
* Enumeration of worker choice strategies.
*/
-export const WorkerChoiceStrategies = Object.freeze({
+export const WorkerChoiceStrategies: Readonly<{
+ ROUND_ROBIN: 'ROUND_ROBIN'
+ LEAST_USED: 'LEAST_USED'
+ LEAST_BUSY: 'LEAST_BUSY'
+ LEAST_ELU: 'LEAST_ELU'
+ FAIR_SHARE: 'FAIR_SHARE'
+ WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+ INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+}> = Object.freeze({
/**
* Round robin worker selection strategy.
*/
WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
/**
* Interleaved weighted round robin worker selection strategy.
- *
* @experimental
*/
- INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+ INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN',
} as const)
/**
/**
* Enumeration of measurements.
*/
-export const Measurements = Object.freeze({
+export const Measurements: Readonly<{
+ runTime: 'runTime'
+ waitTime: 'waitTime'
+ elu: 'elu'
+}> = Object.freeze({
runTime: 'runTime',
waitTime: 'waitTime',
- elu: 'elu'
+ elu: 'elu',
} as const)
/**
readonly measurement?: Measurement
/**
* Runtime options.
- *
* @defaultValue \{ median: false \}
*/
readonly runTime?: MeasurementOptions
/**
* Wait time options.
- *
* @defaultValue \{ median: false \}
*/
readonly waitTime?: MeasurementOptions
/**
* Event loop utilization options.
- *
* @defaultValue \{ median: false \}
*/
readonly elu?: MeasurementOptions
/**
* Worker weights to use for weighted round robin worker selection strategies.
* A weight is tasks maximum execution time in milliseconds for a worker node.
- *
* @defaultValue Weights computed automatically given the CPU performance.
*/
weights?: Record<number, number>
/**
* Measurement statistics requirements.
- *
* @internal
*/
export interface MeasurementStatisticsRequirements {
/**
* Pool worker node worker usage statistics requirements.
- *
* @internal
*/
export interface TaskStatisticsRequirements {
/**
* Strategy policy.
- *
* @internal
*/
export interface StrategyPolicy {
/**
* Worker choice strategy interface.
- *
* @internal
*/
export interface IWorkerChoiceStrategy {
readonly taskStatisticsRequirements: TaskStatisticsRequirements
/**
* Resets strategy internals.
- *
* @returns `true` if the reset is successful, `false` otherwise.
*/
readonly reset: () => boolean
/**
* Updates the worker node key strategy internals.
* This is called after a task has been executed on a worker node.
- *
* @returns `true` if the update is successful, `false` otherwise.
*/
readonly update: (workerNodeKey: number) => boolean
* Chooses a worker node in the pool and returns its key.
* If no worker nodes are not eligible, `undefined` is returned.
* If `undefined` is returned, the caller retry.
- *
* @returns The worker node key or `undefined`.
*/
readonly choose: () => number | undefined
/**
* 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.
*/
readonly remove: (workerNodeKey: number) => boolean
/**
* Sets the worker choice strategy options.
- *
* @param opts - The worker choice strategy options.
*/
readonly setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void
- /**
- * Whether the pool has worker nodes ready or not.
- *
- * @returns Whether the pool has worker nodes ready or not.
- */
- readonly hasPoolWorkerNodesReady: () => boolean
}