X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=28e6aad2c3b56bf529890aad889c9029e4b69777;hb=152e87a8c57c8cbd3a3b437106bcc79c30fcc720;hp=8e9d59cd68eef55bd06076e6e3f9f78e62425c13;hpb=679e657a0c63a51124bea366c6a05faf7b264185;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 8e9d59cd..28e6aad2 100644 --- a/docs/api.md +++ b/docs/api.md @@ -8,16 +8,18 @@ - [`pool.execute(data, name, transferList)`](#poolexecutedata-name-transferlist) - [`pool.start()`](#poolstart) - [`pool.destroy()`](#pooldestroy) - - [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames) - - [`PoolOptions`](#pooloptions) - - [`ThreadPoolOptions extends PoolOptions`](#threadpooloptions-extends-pooloptions) - - [`ClusterPoolOptions extends PoolOptions`](#clusterpooloptions-extends-pooloptions) + - [`pool.hasTaskFunction(name)`](#poolhastaskfunctionname) + - [`pool.addTaskFunction(name, fn)`](#pooladdtaskfunctionname-fn) + - [`pool.removeTaskFunction(name)`](#poolremovetaskfunctionname) + - [`pool.listTaskFunctionsProperties()`](#poollisttaskfunctionsproperties) + - [`pool.setDefaultTaskFunction(name)`](#poolsetdefaulttaskfunctionname) + - [Pool options](#pool-options) - [Worker](#worker) - [`class YourWorker extends ThreadWorker/ClusterWorker`](#class-yourworker-extends-threadworkerclusterworker) - [`YourWorker.hasTaskFunction(name)`](#yourworkerhastaskfunctionname) - [`YourWorker.addTaskFunction(name, fn)`](#yourworkeraddtaskfunctionname-fn) - [`YourWorker.removeTaskFunction(name)`](#yourworkerremovetaskfunctionname) - - [`YourWorker.listTaskFunctionNames()`](#yourworkerlisttaskfunctionnames) + - [`YourWorker.listTaskFunctionsProperties()`](#yourworkerlisttaskfunctionsproperties) - [`YourWorker.setDefaultTaskFunction(name)`](#yourworkersetdefaulttaskfunctionname) ## Pool @@ -37,9 +39,9 @@ ### `pool.execute(data, name, transferList)` -`data` (optional) An object that you want to pass to your worker implementation. +`data` (optional) An object that you want to pass to your worker task function implementation. `name` (optional) A string with the task function name that you want to execute on the worker. Default: `'default'` -`transferList` (optional) An array of transferable objects that you want to transfer to your [worker_threads](https://nodejs.org/api/worker_threads.html) worker implementation. +`transferList` (optional) An array of transferable objects that you want to transfer to your [`ThreadWorker`](#class-yourworker-extends-threadworkerclusterworker) worker implementation. This method is available on both pool implementations and returns a promise with the task function execution response. @@ -57,11 +59,30 @@ This method is available on both pool implementations and will call the terminat This method is available on both pool implementations and returns a boolean. -### `pool.listTaskFunctionNames()` +### `pool.addTaskFunction(name, fn)` -This method is available on both pool implementations and returns an array of the task function names. +`name` (mandatory) The task function name. +`fn` (mandatory) The task function `(data?: Data) => Response | Promise` or task function object `{ taskFunction: (data?: Data) => Response | Promise, priority?: number, strategy?: WorkerChoiceStrategy }`. Priority range is the same as Unix nice levels. + +This method is available on both pool implementations and returns a boolean promise. + +### `pool.removeTaskFunction(name)` + +`name` (mandatory) The task function name. + +This method is available on both pool implementations and returns a boolean promise. + +### `pool.listTaskFunctionsProperties()` -### `PoolOptions` +This method is available on both pool implementations and returns an array of the task function properties. + +### `pool.setDefaultTaskFunction(name)` + +`name` (mandatory) The task function name. + +This method is available on both pool implementations and returns a boolean promise. + +### Pool options An object with these properties: @@ -74,11 +95,11 @@ An object with these properties: - `exitHandler` (optional) - A function that will listen for exit event on each worker. Default: `() => {}` -- `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool: +- `workerChoiceStrategy` (optional) - The default worker choice strategy to use in this pool: - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robin fashion - - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the worker with the minimum number of executed, executing and queued tasks - - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the worker with the minimum tasks total execution and wait time + - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the worker with the minimum number of executing and queued tasks + - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the worker with the minimum tasks execution time - `WorkerChoiceStrategies.LEAST_ELU`: Submit tasks to the worker with the minimum event loop utilization (ELU) - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker by using a [weighted round robin scheduling algorithm](./worker-choice-strategies.md#weighted-round-robin) based on tasks execution time - `WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN`: Submit tasks to worker by using an [interleaved weighted round robin scheduling algorithm](./worker-choice-strategies.md#interleaved-weighted-round-robin-experimental) based on tasks execution time (experimental) @@ -90,20 +111,19 @@ An object with these properties: - `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool. Properties: - - `retries` (optional) - The number of retries to perform if no worker is eligible. - `measurement` (optional) - The measurement to use in worker choice strategies: `runTime`, `waitTime` or `elu`. - `runTime` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) runtime instead of the tasks simple moving average runtime in worker choice strategies. - `waitTime` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) wait time instead of the tasks simple moving average wait time in worker choice strategies. - `elu` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) ELU instead of the tasks simple moving average ELU in worker choice strategies. - - `weights` (optional) - The worker weights to use in weighted round robin worker choice strategies: `{ 0: 200, 1: 300, ..., n: 100 }`. + - `weights` (optional) - The worker weights to use in weighted round robin worker choice strategies: `Record`. - Default: `{ retries: 6, runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }` + Default: `{ runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }` -- `startWorkers` (optional) - Start the minimum number of workers at pool creation. +- `startWorkers` (optional) - Start the minimum number of workers at pool initialization. Default: `true` - `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool. Default: `true` -- `enableEvents` (optional) - Events emission enablement in this pool. +- `enableEvents` (optional) - Pool events integrated with async resource emission enablement. Default: `true` - `enableTasksQueue` (optional) - Tasks queue per worker enablement in this pool. Default: `false` @@ -113,17 +133,14 @@ An object with these properties: - `size` (optional) - The maximum number of tasks that can be queued on a worker before flagging it as back pressured. It must be a positive integer. - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker. It must be a positive integer. - - `taskStealing` (optional) - Task stealing enablement. - - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement on back pressure. - - Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true }` + - `taskStealing` (optional) - Task stealing enablement on idle. + - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement under back pressure. + - `tasksFinishedTimeout` (optional) - Queued tasks finished timeout in milliseconds at worker termination. -#### `ThreadPoolOptions extends PoolOptions` + Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: false, tasksFinishedTimeout: 2000 }` - `workerOptions` (optional) - An object with the worker options to pass to worker. See [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) for more details. -#### `ClusterPoolOptions extends PoolOptions` - - `env` (optional) - An object with the environment variables to pass to worker. See [cluster](https://nodejs.org/api/cluster.html#cluster_cluster_fork_env) for more details. - `settings` (optional) - An object with the cluster settings. See [cluster](https://nodejs.org/api/cluster.html#cluster_cluster_settings) for more details. @@ -132,12 +149,12 @@ An object with these properties: ### `class YourWorker extends ThreadWorker/ClusterWorker` -`taskFunctions` (mandatory) The task function or task functions object `{ name_1: fn_1, ..., name_n: fn_n }` that you want to execute on the worker. +`taskFunctions` (mandatory) The task function or task functions object `Record Response | Promise | { taskFunction: (data?: Data) => Response | Promise, priority?: number, strategy?: WorkerChoiceStrategy }>` that you want to execute on the worker. Priority range is the same as Unix nice levels. `opts` (optional) An object with these properties: - `killBehavior` (optional) - Dictates if your worker will be deleted in case a task is active on it. - **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted. - **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted. + **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **won't** be deleted. + **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted. This option only apply to the newly created workers. Default: `KillBehaviors.SOFT` @@ -159,7 +176,7 @@ This method is available on both worker implementations and returns `{ status: b #### `YourWorker.addTaskFunction(name, fn)` `name` (mandatory) The task function name. -`fn` (mandatory) The task function. +`fn` (mandatory) The task function `(data?: Data) => Response | Promise` or task function object `{ taskFunction: (data?: Data) => Response | Promise, priority?: number, strategy?: WorkerChoiceStrategy }`. Priority range is the same as Unix nice levels. This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`. @@ -169,9 +186,9 @@ This method is available on both worker implementations and returns `{ status: b This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`. -#### `YourWorker.listTaskFunctionNames()` +#### `YourWorker.listTaskFunctionsProperties()` -This method is available on both worker implementations and returns an array of the task function names. +This method is available on both worker implementations and returns an array of the task function properties. #### `YourWorker.setDefaultTaskFunction(name)`