X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=0d3d97300ebae4008707c54f6e05d7591f0f723f;hb=f05afd162e34836a52c48b05781750e3421424d8;hp=2489805c930ff7eb4d40aa0c2075c15f1e817992;hpb=b10bb04924a5918496ff64a62ae71b9f99239b28;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 2489805c..0d3d9730 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,4 +1,4 @@ -ClusterPoolOptions | poolifier
+ClusterPoolOptions | poolifier
-
+
  • poolifier
    • @@ -17,15 +17,16 @@

    Interface ClusterPoolOptions

Options for a poolifier cluster pool.

-
+
+

Hierarchy

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

    Properties

    -
    enableEvents? -enableTasksQueue? -env? -errorHandler? -exitHandler? -messageHandler? -onlineHandler? -settings? -workerChoiceStrategy? -workerChoiceStrategyOptions? +
    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 Value

    true

    +
    +
    +

    Default Value

    true

    -
    -

    Optional Experimental enableTasksQueue

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

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    - -

    Default Value

    false

    +
    +
    +

    Default Value

    false

    -
    -

    Optional env

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

    Optional env

    +
    env?: Record<string, unknown>

    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:21
    • +
    +

    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:110
    • +
    +

    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:118
    • +
    +

    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:106
    • +
    +

    Optional onlineHandler

    +
    onlineHandler?: OnlineHandler<Worker>

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

    -
    -
    -

    Optional settings

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

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    +
    +

    Optional settings

    +
    settings?: ClusterSettings

    Cluster settings.

    - -

    See

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

    +
    +
    +

    See

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

    -
    -

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/cluster/fixed.ts:27
    • +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    +
    +
    +

    Optional workerChoiceStrategy

    +
    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

    -
    -

    Optional workerChoiceStrategyOptions

    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +
  • Defined in src/pools/pool.ts:124
    • +
    +

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -145,28 +179,84 @@
    • -

    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