X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=e0f665fe72edb8d8207ac727c593504a4a7eca81;hb=4eb9e75a6d47a08541d38b70505e5ba1126aa2f1;hp=33c188722210fe375449ba50b39eaa8300da5322;hpb=f0bbd436ca3a985f79cf530ba82805d8d617d509;p=poolifier.git diff --git a/README.md b/README.md index 33c18872..e0f665fe 100644 --- a/README.md +++ b/README.md @@ -161,8 +161,8 @@ An object with these properties: - `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool: - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robin fashion - - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the worker with the minimum number of running and ran tasks - - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the worker with the minimum tasks total execution time + - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the worker with the minimum number of executed, executing and queued tasks + - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the worker with the minimum tasks total execution and wait time - `WorkerChoiceStrategies.LEAST_ELU`: Submit tasks to the worker with the minimum event loop utilization (ELU) (experimental) - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker by using a weighted round robin scheduling algorithm based on tasks execution time - `WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN`: Submit tasks to worker by using an interleaved weighted round robin scheduling algorithm based on tasks execution time (experimental) @@ -174,10 +174,11 @@ An object with these properties: - `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool. Properties: - - `medRunTime` (optional) - Use the tasks median runtime instead of the tasks average runtime in worker choice strategies. + - `runTime` (optional) - Use the tasks median runtime instead of the tasks average runtime in worker choice strategies. + - `waitTime` (optional) - Use the tasks median wait time instead of the tasks average wait time in worker choice strategies. - `weights` (optional) - The worker weights to use in the weighted round robin worker choice strategy: `{ 0: 200, 1: 300, ..., n: 100 }` - Default: `{ medRunTime: false }` + Default: `{ runTime: { median: false }, waitTime: { median: false } }` - `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool. Default: `true` @@ -239,8 +240,8 @@ This method will call the terminate method on each worker. Default: `60000` - `killBehavior` (optional) - 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 `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted. + **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing, then the worker **won't** be deleted. + **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing, then the worker will be deleted. This option only apply to the newly created workers. Default: `KillBehaviors.SOFT`