X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=12df30b4a785786090faf6145c036e6ed8488f89;hb=8662ea71e523af81c1138618f0e12b89df35ce8a;hp=b3473b58bcffe27d2de1f64d5d093b9e30ec74e5;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index b3473b58..12df30b4 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,24 +1,107 @@ -WorkerOptions | poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WorkerOptions

-

Options for workers.

-

Hierarchy

  • WorkerOptions

Index

Properties

Optional async

async?: boolean
-

Whether your worker will perform asynchronous or not.

-
default

false

-

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.

-
    +WorkerOptions | poolifier
    +
    + +
    +
    +
    +
    + +

    Interface WorkerOptions

    +
    +

    Options for workers.

    +
    +
    +

    Hierarchy

    +
      +
    • WorkerOptions
    +
    +
    +
    + +
    +
    +

    Properties

    +
    + +
    async?: boolean
    +

    Whether your worker will perform asynchronous or not.

    + +

    Default

    false

    +
    +
    + +
    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 lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker will be deleted.

    This option only apply to the newly created workers.

    -
    default

    KillBehaviors.SOFT

    -

Optional maxInactiveTime

maxInactiveTime?: number
-

Maximum waiting time in milliseconds for tasks.

-

After this time, newly created workers will be terminated. + +

Default

KillBehaviors.SOFT

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

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

60.000 ms

-

Generated using TypeDoc

\ No newline at end of file + +

Default

60000 ms

+ + +
+

Generated using TypeDoc

+
\ No newline at end of file