import type { TaskFunctionProperties } from '../utility-types.js'
import type {
TaskFunction,
- TaskFunctionObject
+ TaskFunctionObject,
} from '../worker/task-functions.js'
import type {
WorkerChoiceStrategy,
- WorkerChoiceStrategyOptions
+ WorkerChoiceStrategyOptions,
} from './selection-strategies/selection-strategies-types.js'
import type {
ErrorHandler,
IWorkerNode,
MessageHandler,
OnlineHandler,
- WorkerType
+ WorkerType,
} from './worker.js'
/**
/**
* Dynamic pool type.
*/
- dynamic: 'dynamic'
+ dynamic: 'dynamic',
} as const)
/**
destroy: 'destroy',
error: 'error',
taskError: 'taskError',
- backPressure: 'backPressure'
+ backPressure: 'backPressure',
} as const)
/**
export interface TasksQueueOptions {
/**
* Maximum tasks queue size per worker node flagging it as back pressured.
- *
* @defaultValue (pool maximum size)^2
*/
readonly size?: number
/**
* Maximum number of tasks that can be executed concurrently on a worker node.
- *
* @defaultValue 1
*/
readonly concurrency?: number
/**
* Whether to enable task stealing on idle.
- *
* @defaultValue true
*/
readonly taskStealing?: boolean
/**
* Whether to enable tasks stealing under back pressure.
- *
* @defaultValue false
*/
readonly tasksStealingOnBackPressure?: boolean
/**
* Queued tasks finished timeout in milliseconds at worker node termination.
- *
* @defaultValue 2000
*/
readonly tasksFinishedTimeout?: number
/**
* Options for a poolifier pool.
- *
* @typeParam Worker - Type of worker.
*/
export interface PoolOptions<Worker extends IWorker> {
/**
* A function that will listen for online event on each worker.
- *
* @defaultValue `() => {}`
*/
onlineHandler?: OnlineHandler<Worker>
/**
* A function that will listen for message event on each worker.
- *
* @defaultValue `() => {}`
*/
messageHandler?: MessageHandler<Worker>
/**
* A function that will listen for error event on each worker.
- *
* @defaultValue `() => {}`
*/
errorHandler?: ErrorHandler<Worker>
/**
* A function that will listen for exit event on each worker.
- *
* @defaultValue `() => {}`
*/
exitHandler?: ExitHandler<Worker>
/**
* Whether to start the minimum number of workers at pool initialization.
- *
* @defaultValue true
*/
startWorkers?: boolean
/**
* The default worker choice strategy to use in this pool.
- *
* @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
*/
workerChoiceStrategy?: WorkerChoiceStrategy
restartWorkerOnError?: boolean
/**
* Pool events integrated with async resource emission.
- *
* @defaultValue true
*/
enableEvents?: boolean
/**
* Pool worker node tasks queue.
- *
* @defaultValue false
*/
enableTasksQueue?: boolean
tasksQueueOptions?: TasksQueueOptions
/**
* Worker options.
- *
* @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options
*/
workerOptions?: WorkerOptions
/**
* Key/value pairs to add to worker process environment.
- *
* @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
*/
env?: Record<string, unknown>
/**
* Cluster settings.
- *
* @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
*/
settings?: ClusterSettings
/**
* Contract definition for a poolifier pool.
- *
* @typeParam Worker - Type of worker which manages this pool.
* @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
* @typeParam Response - Type of execution response. This can only be structured-cloneable data.
readonly info: PoolInfo
/**
* Pool worker nodes.
- *
* @internal
*/
- readonly workerNodes: Array<IWorkerNode<Worker, Data>>
+ readonly workerNodes: IWorkerNode<Worker, Data>[]
/**
* Pool event emitter integrated with async resource.
* The async tracking tooling identifier is `poolifier:<PoolType>-<WorkerType>-pool`.
readonly emitter?: EventEmitterAsyncResource
/**
* Executes the specified function in the worker constructor with the task data input parameter.
- *
* @param data - The optional task input data for the specified task function. This can only be structured-cloneable data.
* @param name - The optional name of the task function to execute. If not specified, the default task function will be executed.
* @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
readonly destroy: () => Promise<void>
/**
* Whether the specified task function exists in this pool.
- *
* @param name - The name of the task function.
* @returns `true` if the task function exists, `false` otherwise.
*/
/**
* Adds a task function to this pool.
* If a task function with the same name already exists, it will be overwritten.
- *
* @param name - The name of the task function.
* @param fn - The task function.
* @returns `true` if the task function was added, `false` otherwise.
) => Promise<boolean>
/**
* Removes a task function from this pool.
- *
* @param name - The name of the task function.
* @returns `true` if the task function was removed, `false` otherwise.
*/
readonly removeTaskFunction: (name: string) => Promise<boolean>
/**
* Lists the properties of task functions available in this pool.
- *
* @returns The properties of task functions available in this pool.
*/
readonly listTaskFunctionsProperties: () => TaskFunctionProperties[]
/**
* Sets the default task function in this pool.
- *
* @param name - The name of the task function.
* @returns `true` if the default task function was set, `false` otherwise.
*/
readonly setDefaultTaskFunction: (name: string) => Promise<boolean>
/**
* Sets the default worker choice strategy in this pool.
- *
* @param workerChoiceStrategy - The default worker choice strategy.
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
) => void
/**
* Sets the worker choice strategy options in this pool.
- *
* @param workerChoiceStrategyOptions - The worker choice strategy options.
* @returns `true` if the worker choice strategy options were set, `false` otherwise.
*/
) => boolean
/**
* Enables/disables the worker node tasks queue in this pool.
- *
* @param enable - Whether to enable or disable the worker node tasks queue.
* @param tasksQueueOptions - The worker node tasks queue options.
*/
) => void
/**
* Sets the worker node tasks queue options in this pool.
- *
* @param tasksQueueOptions - The worker node tasks queue options.
*/
readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
repositories / poolifier.git / blobdiff