- [`pool.execute(data, name, transferList)`](#poolexecutedata-name-transferlist)
- [`pool.start()`](#poolstart)
- [`pool.destroy()`](#pooldestroy)
+ - [`pool.hasTaskFunction(name)`](#poolhastaskfunctionname)
+ - [`pool.addTaskFunction(name, fn)`](#pooladdtaskfunctionname-fn)
+ - [`pool.removeTaskFunction(name)`](#poolremovetaskfunctionname)
- [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames)
+ - [`pool.setDefaultTaskFunction(name)`](#poolsetdefaulttaskfunctionname)
- [`PoolOptions`](#pooloptions)
- - [`ThreadPoolOptions extends PoolOptions`](#threadpooloptions-extends-pooloptions)
- - [`ClusterPoolOptions extends PoolOptions`](#clusterpooloptions-extends-pooloptions)
- [Worker](#worker)
- [`class YourWorker extends ThreadWorker/ClusterWorker`](#class-yourworker-extends-threadworkerclusterworker)
- [`YourWorker.hasTaskFunction(name)`](#yourworkerhastaskfunctionname)
### `pool = new FixedThreadPool/FixedClusterPool(numberOfThreads/numberOfWorkers, filePath, opts)`
-`numberOfThreads/numberOfWorkers` (mandatory) Number of workers for this pool
-`filePath` (mandatory) Path to a file with a worker implementation
-`opts` (optional) An object with the pool options properties described below
+`numberOfThreads/numberOfWorkers` (mandatory) Number of workers for this pool.
+`filePath` (mandatory) Path to a file with a worker implementation.
+`opts` (optional) An object with the pool options properties described below.
### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`
-`min` (mandatory) Same as _FixedThreadPool_/_FixedClusterPool_ numberOfThreads/numberOfWorkers, this number of workers will be always active
+`min` (mandatory) Same as _FixedThreadPool_/_FixedClusterPool_ numberOfThreads/numberOfWorkers, this number of workers will be always active.
`max` (mandatory) Max number of workers that this pool can contain, the newly created workers will die after a threshold (default is 1 minute, you can override it in your worker implementation).
-`filePath` (mandatory) Path to a file with a worker implementation
-`opts` (optional) An object with the pool options properties described below
+`filePath` (mandatory) Path to a file with a worker implementation.
+`opts` (optional) An object with the pool options properties described below.
### `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.
### `pool.hasTaskFunction(name)`
-`name` (mandatory) The task function name
+`name` (mandatory) The task function name.
This method is available on both pool implementations and returns a boolean.
+### `pool.addTaskFunction(name, fn)`
+
+`name` (mandatory) The task function name.
+`fn` (mandatory) The task function.
+
+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.listTaskFunctionNames()`
This method is available on both pool implementations and returns an array of the task function names.
+### `pool.setDefaultTaskFunction(name)`
+
+`name` (mandatory) The task function name.
+
+This method is available on both pool implementations and returns a boolean promise.
+
### `PoolOptions`
An object with these properties:
Default: `{ retries: 6, 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) - Events integrated with async resource emission enablement in this pool.
Default: `true`
- `enableTasksQueue` (optional) - Tasks queue per worker enablement in this pool.
Default: `false`
- `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.
+ - `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.
- Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true }`
-
-#### `ThreadPoolOptions extends PoolOptions`
+ Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true, tasksFinishedTimeout: 1000 }`
- `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.
### `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 `{ name_1: fn_1, ..., name_n: fn_n }` that you want to execute on the worker.
`opts` (optional) An object with these properties:
- `killBehavior` (optional) - Dictates if your worker will be deleted in case a task is active on it.
#### `YourWorker.hasTaskFunction(name)`
-`name` (mandatory) The task function name
+`name` (mandatory) The task function name.
This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
#### `YourWorker.addTaskFunction(name, fn)`
-`name` (mandatory) The task function name
-`fn` (mandatory) The task function
+`name` (mandatory) The task function name.
+`fn` (mandatory) The task function.
This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
#### `YourWorker.removeTaskFunction(name)`
-`name` (mandatory) The task function name
+`name` (mandatory) The task function name.
This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
#### `YourWorker.setDefaultTaskFunction(name)`
-`name` (mandatory) The task function name
+`name` (mandatory) The task function name.
This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
repositories / poolifier.git / blobdiff