X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=fa472042b38f867860ecc93d0038322bcd8971f7;hb=aab0aa502b6d1ca1e2b480460d9cf5f34707c34c;hp=0bc580d596529ca0e1acc319d60988cda9f338bc;hpb=ccb7d1a70cd9bd4eb050160517e5bc48311d014f;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 0bc580d5..1dc5ba66 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,13 +1,13 @@ -ClusterPoolOptions | poolifier
+ClusterPoolOptions | poolifier - v2.7.4
-
+
  • The search index is not available
  • poolifier - v2.7.4 +
    @@ -17,7 +17,8 @@

    Interface ClusterPoolOptions

    Options for a poolifier cluster pool.

    -
    +
    +

    Hierarchy

    +
  • Defined in src/pools/cluster/fixed.ts:10
  • - +

    Properties

    - +
    enableEvents?: boolean
    -

    Pool events emission.

    - -

    Default Value

    true

    +

    Pool events integrated with async resource emission.

    +
    +
    +

    Default Value

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

    Pool worker tasks queue.

    - -

    Default Value

    false

    +

    Pool worker node tasks queue.

    +
    +
    +

    Default Value

    false
    +
    +
  • Defined in src/pools/pool.ts:187
  • - -
    env?: any
    + +
    env?: Record<string, unknown>

    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:16
  • - +
    errorHandler?: ErrorHandler<Worker>

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

    +
  • Defined in src/pools/pool.ts:137
  • - +
    restartWorkerOnError?: boolean

    Restart worker on error.

    -
    +
    +
  • Defined in src/pools/pool.ts:175
  • - +
    settings?: ClusterSettings

    Cluster settings.

    - -

    See

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

    +
    +
    +

    See

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

    +
    +
    + +
    startWorkers?: boolean
    +

    Whether to start the minimum number of workers at pool initialization.

    +
    +
    +

    Default Value

    true
    +
    +
  • Defined in src/pools/pool.ts:161
  • - +
    tasksQueueOptions?: TasksQueueOptions
    -

    Pool worker tasks queue options.

    -
    +
  • Defined in src/pools/pool.ts:191
  • - -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    + +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    - -

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
    +
    +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
    +
    +
  • Defined in src/pools/pool.ts:167
  • - +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    +
  • Defined in src/pools/pool.ts:171
  • -

    On This Page

    +

    On This Page

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file