X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=2a2b5a8634f200ca9721682ed1444022f3dba57f;hb=86de0a2d983a71579980758f52cf4c7f1c16abf8;hp=954da0f6297c2dedb40a4474eac8b78131a07378;hpb=88d983fa5c8db26fa52b8a69a2b724ade989db9b;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 954da0f6..2a2b5a86 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,151 +1,25 @@ -WorkerOptions | poolifier
-
- -
-
-
-
- -

Interface WorkerOptions

-
-

Options for workers.

-
-
-

Hierarchy

-
    -
  • WorkerOptions
-
-
-
- -
-
-

Properties

-
async? -killBehavior? -maxInactiveTime? -
-
-

Properties

-
-

Optional async

-
async?: boolean
-

Whether your worker will perform asynchronous or not.

- -

Default Value

false

- -

Deprecated

This option will be removed in the next major version.

-
-
-

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

-
-
-

Optional maxInactiveTime

-
maxInactiveTime?: number
-

Maximum waiting time in milliseconds for tasks.

+

Default Value

KillBehaviors.SOFT
+
+

Optional killHandler

killHandler?: KillHandler

The function to call when a worker is killed.

+

Default Value

() => {}

+

Optional maxInactiveTime

maxInactiveTime?: number

Maximum 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.

  • If 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.
    • +when this timeout expires your tasks is interrupted before completion and removed. 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.
- -

Default Value

60000

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Default Value

60000
+
+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file