X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=dc956759aef4cfa76ae4a409e4a4cd0a1fa1dd2c;hb=36b5e78f5d0a98040273f48b409e643fe5902913;hp=f60542c9c49f561dce97679a15d7b564cfa7bbd5;hpb=baf969c13b6c1bbb5f85c62f606f23fdb5f2d65c;p=poolifier.git diff --git a/README.md b/README.md index f60542c9..dc956759 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,6 @@
@@ -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 }
@@ -122,11 +120,14 @@ const pool = new FixedThreadPool(15,
'./yourWorker.js',
{ errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+pool.emitter.on('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('full', () => console.log('Pool is full'))
pool.emitter.on('busy', () => console.log('Pool is busy'))
// the execute method signature is the same for both implementations,
@@ -165,8 +166,9 @@ 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
@@ -205,7 +207,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 +252,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