X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=2a1bb46ceab42556ee16237ce79790d2e8da7af7;hb=1cc6e9ef64f399f4ca58da8079ef72a011ac4227;hp=205faf66e7cdb5869ec0e02223eaf6f758664f76;hpb=b4d61a7596f314145be453ddbcaa9b0dade39bfb;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 205faf66..2a1bb46c 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,15 +1,15 @@ -
Optional
asyncOptional
asyncWhether your worker will perform asynchronous or not.
+false
+
-false
+This option will be removed in the next major version.
Optional
killkillBehavior
dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
Optional
killkillBehavior
dictates if your worker will be deleted in case a task is active on it.
currentTime - lastActiveTime
is greater than maxInactiveTime
but a task is still running, then the worker won't be deleted.currentTime - lastActiveTime
is greater than maxInactiveTime
but a task is still running, then the worker will be deleted.currentTime - lastActiveTime
is greater than maxInactiveTime
but a task is still executing or queued, then the worker won't be deleted.currentTime - lastActiveTime
is greater than maxInactiveTime
but a task is still executing or queued, then the worker will be deleted.This option only apply to the newly created workers.
- -KillBehaviors.SOFT
+KillBehaviors.SOFT
+
+Optional
killThe function to call when a worker is killed.
+() => {}
Optional
maxMaximum waiting time in milliseconds for tasks.
+Optional
maxMaximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.
After this time, newly created workers will be terminated. -The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.
+The last active time of your worker will be updated when it terminates a task.killBehavior
is set to KillBehaviors.HARD
this value represents also the timeout for the tasks that you submit to the pool,
-when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.killBehavior
is set to KillBehaviors.SOFT
your tasks have no timeout and your workers will not be terminated until your task is completed.60000 ms
+60000
+
Generated using TypeDoc
Generated using TypeDoc
Options for workers.
-