X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.MD;h=ca3d51b70e22d44b006cec2064935c732913de2a;hb=d3537e39561e15aa2f2ff927e50ca5ded0a4d6b2;hp=ed090736128b05e73cb47a8a898f1b469ff2cf14;hpb=754c89d2de8c821fea456b823998ce817a7c1be7;p=poolifier.git
diff --git a/README.MD b/README.MD
index ed090736..ca3d51b7 100644
--- a/README.MD
+++ b/README.MD
@@ -2,7 +2,17 @@
[](https://standardjs.com)
[](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)
[](https://github.com/pioardi/node-pool/actions)
+[](https://coveralls.io/github/pioardi/node-thread-pool?branch=master)
[](http://makeapullrequest.com)
+[](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
+)
+
+Why Poolifier?
+Poolifier is used to perform heavy CPU bound tasks on nodejs servers, it implements thread pools ( yes, more thread pool implementations, so you can choose which one fit better for you ) using worker-threads .
+With poolifier you can improve your performance and resolve problems related to the event loop.
+Moreover you can execute your CPU tasks using an API designed to improve the developer experience.
+
Contents
@@ -25,12 +35,12 @@
Overview
Node pool contains two worker-threads pool implementations , you don' t have to deal with worker-threads complexity.
The first implementation is a static thread pool , with a defined number of threads that are started at creation time and will be reused.
-The second implementation is a dynamic thread pool with a number of threads started at creation time ( these threads will be always active and reused) and other threads created when the load will increase ( with an upper limit ), the new created threads will be stopped after a configurable period of inactivity.
+The second implementation is a dynamic thread pool with a number of threads started at creation time ( these threads will be always active and reused) and other threads created when the load will increase ( with an upper limit, these threads will be reused when active ), the new created threads will be stopped after a configurable period of inactivity.
You have to implement your worker extending the ThreadWorker class
Installation
```
-npm install node-thread-pool --save
+npm install poolifier --save
```
Usage
@@ -38,33 +48,33 @@ You can implement a worker in a simple way , extending the class ThreadWorker :
```js
'use strict'
-const { ThreadWorker } = require('node-pool')
-
-class MyWorker extends ThreadWorker {
- constructor () {
- super((data) => {
- // this will be executed in the worker thread,
- // the data will be received by using the execute method
- return { ok: 1 }
- }, { maxInactiveTime: 1000 * 60})
- }
+const { ThreadWorker } = require('poolifier')
+
+function yourFunction (data) {
+ // this will be executed in the worker thread,
+ // the data will be received by using the execute method
+ return { ok: 1 }
}
-module.exports = new MyWorker()
+
+module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000 })
```
-Instantiate your pool based on your needed :
+Instantiate your pool based on your needed :
```js
'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('node-pool')
+const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
// a fixed thread pool
const pool = new FixedThreadPool(15,
- './yourWorker.js')
+ './yourWorker.js',
+ { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
// or a dynamic thread pool
const pool = new DynamicThreadPool(10, 100,
- './yourWorker.js')
+ './yourWorker.js',
+ { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+
pool.emitter.on('FullPool', () => console.log('Pool is full'))
// the execute method signature is the same for both implementations,
@@ -75,11 +85,11 @@ pool.execute({}).then(res => {
```
- See examples folder for more details.
+ See examples folder for more details ( in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js) ).
Node versions
-You can use node version 10.x with --experimental-worker flag, or you can use an higher version (i.e 12.x)
+You can use node versions 12.x , 13.x
API
@@ -113,20 +123,20 @@ This method will call the terminate method on each worker.
- `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die.
Choose your pool
-Performance is one of the main target of these thread pool implementation, we want to have a strong focus on this.
+Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.
We already have a bench folder where you can find some comparisons.
To choose your pool consider that with a FixedThreadPool or a DynamicThreadPool ( in this case is important the min parameter passed to the constructor) your application memory footprint will increase .
-Increasing the memory footprint your application will be ready to accept more CPU bound tasks, but during idle time your application will consume more memory.
+Increasing the memory footprint, your application will be ready to accept more CPU bound tasks, but during idle time your application will consume more memory.
One good choose from my point of view is to profile your application using Fixed/Dynamic thread pool , and to see your application metrics when you increase/decrease the num of threads.
-For example you could keep the memory footprint low choosing a DynamicThreadPool with 5 threads, and allow to create new threads until 50/100 when requests, this is the advantage to use the DynamicThreadPool.
+For example you could keep the memory footprint low choosing a DynamicThreadPool with 5 threads, and allow to create new threads until 50/100 when needed, this is the advantage to use the DynamicThreadPool.
But in general , always profile your application
Contribute
-See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md)
+See guidelines [CONTRIBUTING](CONTRIBUTING.md)
+Choose your task here 2.0.0, propose an idea, a fix, an improvement.
License
[MIT](./LICENSE)
-