X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=6cce306ddcf5adbf7df0fe29744e7c7ce18e65f9;hb=71056a0ac555e096c1428d6341ef45c7980a6332;hp=6adf2513406f7c722186a6af9d2bfba3bcd6c7fa;hpb=7e2a464b15953320c79646e2ff88d953db4e5b96;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 6adf2513..c45d9899 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,13 +1,15 @@ -ClusterPoolOptions | poolifier
+ClusterPoolOptions | poolifier
-
+
-
+
  • poolifier
    • @@ -15,15 +17,16 @@

    Interface ClusterPoolOptions

Options for a poolifier cluster pool.

-
+
+

Hierarchy

+
  • Defined in src/pools/cluster/fixed.ts:15
    • @@ -31,79 +34,142 @@

    Properties

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

    Properties

    -
    -

    Optional enableEvents

    -
    enableEvents?: boolean
    +
    +

    Optional enableEvents

    +
    enableEvents?: boolean

    Pool events emission.

    - -

    Default

    true

    +
    +
    +

    Default Value

    true

    -
    -

    Optional env

    -
    env?: any
    +
  • Defined in src/pools/pool.ts:136
    • +
    +

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    +
    +
    +

    Default Value

    false

    +
    +
    +

    Optional env

    +
    env?: any

    Key/value pairs to add to worker process environment.

    - -

    See

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

    +
    +
    +

    See

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

    -
    -

    Optional errorHandler

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

    Optional errorHandler

    +
    errorHandler?: ErrorHandler<Worker>

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

    -
    +
    -
    -

    Optional exitHandler

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

    Optional exitHandler

    +
    exitHandler?: ExitHandler<Worker>

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

    -
    +
    -
    -

    Optional messageHandler

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

    Optional messageHandler

    +
    messageHandler?: MessageHandler<Worker>

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

    -
    -
    -

    Optional onlineHandler

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

    Optional onlineHandler

    +
    onlineHandler?: OnlineHandler<Worker>

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

    -
    -
    -

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/pool.ts:112
    • +
    +

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    +
    +

    Optional settings

    +
    settings?: ClusterSettings
    +

    Cluster settings.

    +
    +
    +

    See

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

    +
    +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    +
    +
    +

    Optional workerChoiceStrategy

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

    The worker choice strategy options.

    +
    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -113,25 +179,76 @@
    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • enableEvents
    • +
  • enableTasksQueue
    • +
  • env
    • +
  • errorHandler
    • +
  • exitHandler
    • +
  • messageHandler
    • +
  • onlineHandler
    • +
  • restartWorkerOnError
    • +
  • settings
    • +
  • tasksQueueOptions
    • +
  • workerChoiceStrategy
    • +
  • workerChoiceStrategyOptions
    • +
    +
    +

    Generated using TypeDoc

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