X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=25eec6000f56dcd9df217e87387d7bc56d1e1e2b;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=81e1d2fd08dbe1a89de7150102bbbd70285a1d11;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 81e1d2fd..25eec600 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier
+WorkerOptions | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:28
    • @@ -34,6 +34,7 @@

    Properties

    async? killBehavior? +killHandler? maxInactiveTime?
    @@ -49,14 +50,14 @@

    Deprecated

    This option will be removed in the next major version.

    +
  • Defined in src/worker/worker-options.ts:48

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

    +

    killBehavior dictates if your worker will be deleted in case 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.

    @@ -64,16 +65,24 @@

    Default Value

    KillBehaviors.SOFT

    +
  • Defined in src/worker/worker-options.ts:59
    • +
    +

    Optional killHandler

    +
    killHandler?: KillHandler
    +

    The function to call when a worker is killed.

    +
    +

    Optional maxInactiveTime

    maxInactiveTime?: number
    -

    Maximum waiting time in milliseconds for tasks.

    +

    Maximum waiting time in milliseconds for tasks on newly created workers.

    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.
    @@ -81,7 +90,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default Value

    60000

    +
  • Defined in src/worker/worker-options.ts:41
    • @@ -103,9 +112,10 @@ when this timeout expires your tasks is interrupted and the worker is killed if
    -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file