X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=cb505a286755a7b8aa186d4b7a6ed07a404d5cea;hb=019581cc38fe0b47645d9b2120f325ab37388be2;hp=7cb5491b12d5deb09ad0135786f5b78ab5612ce7;hpb=797996a92f40d5779cd31314b59462e41d529989;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 7cb5491b..cb505a28 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier
+WorkerOptions | poolifier - v2.6.28
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.28
    -
    +
    • poolifier
      • @@ -17,13 +17,14 @@

      Interface WorkerOptions

    Options for workers.

    -
    +
    +

    Hierarchy

    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:28
    • @@ -31,55 +32,70 @@

    Properties

    -
    async? -killBehavior? -maxInactiveTime? +
    async? +killBehavior? +killHandler? +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"
    -

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

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

    Optional killBehavior

    +
    killBehavior?: "SOFT" | "HARD"
    +

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

    Maximum waiting time in milliseconds for tasks.

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

    Optional killHandler

    +
    killHandler?: KillHandler
    +

    The function to call when a worker is killed.

    +
    +
    +
    +

    Optional maxInactiveTime

    +
    maxInactiveTime?: number
    +

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

    Default Value

    60000 ms

    +
    +
    +

    Default Value

    60000

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

    Settings

     +

    Settings

    Member Visibility

    @@ -89,21 +105,78 @@ when this timeout expires your tasks is interrupted and the worker is killed if
    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • async
    • +
  • killBehavior
    • +
  • killHandler
    • +
  • maxInactiveTime
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file