X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=3febd8f6829975573f21dd12fc3335d299ad3897;hb=6c15ffb2e59f4b3eaa6aedf0eb27feb2150cfb40;hp=4944694e333c2eda7e3d3469fc0cb20e5f0656ca;hpb=3bd6a82e43e11294af91bbd19647944ac740169e;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 4944694e..3febd8f6 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -21,11 +21,11 @@

Hierarchy

+
  • Defined in src/pools/cluster/fixed.ts:15
    • @@ -40,6 +40,7 @@ exitHandler? messageHandler? onlineHandler? +restartWorkerOnError? settings? tasksQueueOptions? workerChoiceStrategy? @@ -49,100 +50,108 @@

    Properties

    Optional enableEvents

    -
    enableEvents?: boolean
    +
    enableEvents?: boolean

    Pool events emission.

    Default Value

    true

    +
  • Defined in src/pools/pool.ts:136

    • Optional enableTasksQueue

    -
    enableTasksQueue?: boolean
    +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    Default Value

    false

    +
  • Defined in src/pools/pool.ts:142

    • Optional env

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

    • Optional errorHandler

    -
    errorHandler?: ErrorHandler<Worker>
    +
    errorHandler?: ErrorHandler<Worker>

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

    +
  • Defined in src/pools/pool.ts:108

    • Optional exitHandler

    -
    exitHandler?: ExitHandler<Worker>
    +
    exitHandler?: ExitHandler<Worker>

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

    +
  • Defined in src/pools/pool.ts:116

    • Optional messageHandler

    -
    messageHandler?: MessageHandler<Worker>
    +
    messageHandler?: MessageHandler<Worker>

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

    +
  • Defined in src/pools/pool.ts:104

    • Optional onlineHandler

    -
    onlineHandler?: OnlineHandler<Worker>
    +
    onlineHandler?: OnlineHandler<Worker>

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

    +
  • Defined in src/pools/pool.ts:112
    • +
    +

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +

    Optional settings

    -
    settings?: ClusterSettings
    +
    settings?: ClusterSettings

    Cluster settings.

    See

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

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

    • Optional tasksQueueOptions

    -
    tasksQueueOptions?: TasksQueueOptions
    +
    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

    +
  • Defined in src/pools/pool.ts:146

    • Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
  • Defined in src/pools/pool.ts:122

    • Optional workerChoiceStrategyOptions

    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:126
    • @@ -169,6 +178,7 @@
  • exitHandler
  • messageHandler
  • onlineHandler
    • +
  • restartWorkerOnError
  • settings
  • tasksQueueOptions
  • workerChoiceStrategy
    • @@ -176,7 +186,6 @@
    +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes

    • Generated using TypeDoc

    \ No newline at end of file