X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=efe0e410ae32bc05a20fda449fa42aeba820561e;hb=fbc22127e53d3ec0ecbd38ecea25fb92ebef50e7;hp=038ad0f6aa205e4c4838ab43a458b1e2b95114b9;hpb=bfed591d93e26b1e424e916abdb27c6f91dc9b45;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 038ad0f6..efe0e410 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,4 +1,4 @@ -ClusterPoolOptions | poolifier
+ClusterPoolOptions | poolifier
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier
    -
    +
    @@ -33,89 +33,121 @@

    Properties

    -
    +
    -
    enableEvents?: boolean
    +
    enableEvents?: boolean

    Pool events emission.

    -

    Default

    true

    +

    Default Value

    true

    -
    +
  • Defined in src/pools/pool.ts:99
  • +
    + +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    + +

    Default Value

    false

    +
    +
    -
    env?: any
    +
    env?: any

    Key/value pairs to add to worker process environment.

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

    -
    +
  • Defined in src/pools/cluster/fixed.ts:18
  • +
    -
    errorHandler?: ErrorHandler<Worker>
    +
    errorHandler?: ErrorHandler<Worker>

    A function that will listen for error event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:75
  • +
    -
    exitHandler?: ExitHandler<Worker>
    +
    exitHandler?: ExitHandler<Worker>

    A function that will listen for exit event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:83
  • +
    -
    messageHandler?: MessageHandler<Worker>
    +
    messageHandler?: MessageHandler<Worker>

    A function that will listen for message event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:71
  • +
    -
    onlineHandler?: OnlineHandler<Worker>
    +
    onlineHandler?: OnlineHandler<Worker>

    A function that will listen for online event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:79
  • +
    -
    settings?: ClusterSettings
    +
    settings?: ClusterSettings
    -
    +
  • Defined in src/pools/cluster/fixed.ts:24
  • +
    + +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    +
    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    + +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    - +
    +
    +
    +

    On This Page

    -
    -
    +
  • enableEvents
  • +
  • enableTasksQueue
  • +
  • env
  • +
  • errorHandler
  • +
  • exitHandler
  • +
  • messageHandler
  • +
  • onlineHandler
  • +
  • settings
  • +
  • tasksQueueOptions
  • +
  • workerChoiceStrategy
  • +
  • workerChoiceStrategyOptions
  • + +

    Generated using TypeDoc

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