- Performance :racehorse: [benchmarks](./benchmarks/README.md)
- Security :bank: :cop: [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=security_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
- Easy to use :couple:
-- Easy switch from a pool to another, easy to tune :heavy_check_mark:
-- Dynamic pool size :heavy_check_mark:
-- No runtime dependencies :heavy_check_mark:
-- Proper async integration with node async hooks :heavy_check_mark:
-- Support for worker threads and cluster node modules :heavy_check_mark:
-- Support sync and async tasks :heavy_check_mark:
-- General guidance on pools to use :heavy_check_mark:
-- Widely tested :heavy_check_mark:
-- Error handling out of the box :heavy_check_mark:
-- Active community :heavy_check_mark:
+- Easy switch from a pool to another, easy to tune :white_check_mark:
+- Dynamic pool size :white_check_mark:
+- No runtime dependencies :white_check_mark:
+- Proper async integration with node async hooks :white_check_mark:
+- Support for worker threads and cluster node modules :white_check_mark:
+- Support sync and async tasks :white_check_mark:
+- General guidance on pools to use :white_check_mark:
+- Widely tested :white_check_mark:
+- Error handling out of the box :white_check_mark:
+- Active community :white_check_mark:
- Code quality :octocat: [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=bugs)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=code_smells)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
## Node versions
-You can use node versions >= 12.x for thread pool, and node versions >= 16.x for cluster pool.
+Node versions >= 16.x are supported.
## API
+### [Documentation](https://poolifier.github.io/poolifier/)
+
### `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 these properties:
+- `messageHandler` (optional) - A function that will listen for message event on each worker
- `errorHandler` (optional) - A function that will listen for error event on each worker
- `onlineHandler` (optional) - A function that will listen for online event on each worker
- `exitHandler` (optional) - A function that will listen for exit event on each worker
-- `workerChoiceStrategy` (optional) - The work choice strategy to use in this pool:
+- `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool:
- - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in this pool in a round robbin fashion
- - `WorkerChoiceStrategies.LESS_RECENTLY_USED`: Submit tasks to the less recently used worker in the pool
+ - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robbin fashion
+ - `WorkerChoiceStrategies.LESS_RECENTLY_USED`: Submit tasks to the less recently used worker
+ - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time
+ - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time
+ `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks
Default: `WorkerChoiceStrategies.ROUND_ROBIN`
- `enableEvents` (optional) - Events emission enablement in this pool. Default: true
If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
Default: 60000 ms
-- `async` - true/false, true if your function contains async pieces else false
+- `async` - true/false, true if your function contains async code pieces, else false
- `killBehavior` - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
**KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted.
**KillBehaviors.HARD**: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
## Contribute
See guidelines [CONTRIBUTING](CONTRIBUTING.md)
-Choose your task here [2.3.0](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
+Choose your task here [2.3.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
## Team