X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=c03ba9785fa428be379188f042224f4a31bdd749;hb=b667be1103b9362ae29d094de05f812468464d4f;hp=955c77f829da7527b771cf958f14f892d9dce35e;hpb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 955c77f8..c03ba978 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier

+WorkerOptions | poolifier - v2.6.8

@@ -17,13 +17,14 @@

Interface WorkerOptions

Options for workers.

Hierarchy

WorkerOptions

Defined in src/worker/worker-options.ts:23

@@ -31,38 +32,42 @@

Properties

async? -killBehavior? -maxInactiveTime? +

async? +killBehavior? +maxInactiveTime?

Properties

`Optional` async

async?: boolean

`Optional` async

async?: boolean

Whether your worker will perform asynchronous or not.

Default Value

false

Default Value

false

Deprecated

This option will be removed in the next major version.

`Optional` killBehavior

killBehavior?: "SOFT" | "HARD"

Defined in src/worker/worker-options.ts:43

`Optional` killBehavior

killBehavior?: "SOFT" | "HARD"

killBehavior dictates if your async unit (worker/process) will be deleted in case that a task is active on it.

SOFT: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker won't be deleted.
HARD: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker will be deleted.
SOFT: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker won't be deleted.
HARD: If 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.

- -

Default Value

KillBehaviors.SOFT

Default Value

KillBehaviors.SOFT

`Optional` maxInactiveTime

maxInactiveTime?: number

Defined in src/worker/worker-options.ts:54

`Optional` maxInactiveTime

maxInactiveTime?: number

Maximum waiting time in milliseconds for tasks.

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.

@@ -71,16 +76,17 @@ The last active time of your worker unit will be updated when a task is submitte when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.

If killBehavior is set to KillBehaviors.SOFT your tasks have no timeout and your workers will not be terminated until your task is completed.

- -