X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=da1690207e21ce6cea04dbe87f3768f3641132d6;hb=refs%2Ftags%2Fv2.4.6;hp=ead314833872725729537434b19aefa5704c1aba;hpb=a746be5b3f476db0d65dedbe147e690f432e9e03;p=poolifier.git
diff --git a/README.md b/README.md
index ead31483..da169020 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,6 @@
Node Thread Pool and Cluster Pool :arrow_double_up: :on:
-
-
- 
-
@@ -16,11 +12,13 @@
- 
+
+
+ 
@@ -99,7 +97,7 @@ You can implement a worker-threads worker in a simple way by extending the class
'use strict'
const { ThreadWorker } = require('poolifier')
-function yourFunction (data) {
+function yourFunction(data) {
// this will be executed in the worker thread,
// the data will be received by using the execute method
return { ok: 1 }
@@ -115,19 +113,22 @@ Instantiate your pool based on your needed :
```js
'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
+const { DynamicThreadPool, FixedThreadPool, PoolEvents } = require('poolifier')
// a fixed worker-threads pool
const pool = new FixedThreadPool(15,
'./yourWorker.js',
{ errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
+
// or a dynamic worker-threads pool
const pool = new DynamicThreadPool(10, 100,
'./yourWorker.js',
{ errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
-pool.emitter.on('busy', () => console.log('Pool is busy'))
+pool.emitter.on(PoolEvents.full, () => console.log('Pool is full'))
+pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
// the execute method signature is the same for both implementations,
// so you can easy switch from one to another
@@ -146,7 +147,7 @@ Remember that workers can only send and receive serializable data.
## Node versions
-Bode node versions >= 16.x are supported.
+Node versions >= 16.x are supported.
## API
@@ -165,14 +166,22 @@ Bode node versions >= 16.x are supported.
- `workerChoiceStrategy` (optional) - The worker choice strategy to use in this 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.LESS_USED`: Submit tasks to the less used worker
+ - `WorkerChoiceStrategies.LESS_BUSY`: Submit tasks to the less busy 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`
+- `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool.
+ Properties:
+
+ - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time in worker choice strategies.
+ Default: { medRunTime: false }
+
- `enableEvents` (optional) - Events emission enablement in this pool. Default: true
+- `enableTasksQueue` (optional, experimental) - Tasks queue per worker enablement in this pool. Default: false
### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`
@@ -205,7 +214,7 @@ This method will call the terminate method on each worker.
- `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.
+ **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
This option only apply to the newly created workers.
Default: `KillBehaviors.SOFT`
@@ -250,7 +259,7 @@ But in general, **always profile your application**
## Contribute
See guidelines [CONTRIBUTING](CONTRIBUTING.md)
-Choose your task here [2.3.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
+Choose your task here [2.4.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
## Team