X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2Fworkeroptions.html;h=56997f62caf767adcee373ee1867897739e8ee5c;hb=4f4ae1cb3c33228a023ea599c2648268d15e6c0f;hp=36932f277f7671cfbe4212d1d8952aab9982a259;hpb=849e05470ba75db08bb8def0c547ab4d8c35c9a0;p=poolifier.git diff --git a/docs/interfaces/workeroptions.html b/docs/interfaces/workeroptions.html index 36932f27..56997f62 100644 --- a/docs/interfaces/workeroptions.html +++ b/docs/interfaces/workeroptions.html @@ -1,296 +1,24 @@ - - - - - - WorkerOptions | poolifier - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
- -

Interface WorkerOptions

-
-
-
-
-
-
-
-
-
-

Options for workers.

-
-
-
-
-

Hierarchy

-
    -
  • - WorkerOptions -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional async

-
async: undefined | boolean
- -
-
-

Whether your worker will perform asynchronous or not.

-
-
-
default
-

false

-
-
-
-
-
- -

Optional killBehavior

-
killBehavior: undefined | "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: undefined | 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 +WorkerOptions | poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WorkerOptions

+

Options for workers.

+

Hierarchy

  • WorkerOptions

Index

Properties

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.

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