X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=47ee6a9a889c452ebefdae711e380cbf46759331;hb=9aa78bcb34d9d6002c71ce3de1ece85dd164871f;hp=5f8708ca55bdb22097240101a2881b865fb00b3c;hpb=22c85455d2f30345148aa3e1304d3b0840102f72;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 5f8708ca..47ee6a9a 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,40 +1,5 @@ -ClusterPoolOptions | poolifier - v2.6.41
-
- -
-
-
-
- -

Interface ClusterPoolOptions

-
-

Options for a poolifier cluster pool.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
enableEvents? +ClusterPoolOptions | poolifier - v3.0.11

Interface ClusterPoolOptions

Options for a poolifier cluster pool.

+
interface ClusterPoolOptions {
    enableEvents?: boolean;
    enableTasksQueue?: boolean;
    env?: Record<string, unknown>;
    errorHandler?: ErrorHandler<Worker>;
    exitHandler?: ExitHandler<Worker>;
    messageHandler?: MessageHandler<Worker>;
    onlineHandler?: OnlineHandler<Worker>;
    restartWorkerOnError?: boolean;
    settings?: ClusterSettings;
    startWorkers?: boolean;
    tasksQueueOptions?: TasksQueueOptions;
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
}

Hierarchy

Properties

enableEvents? enableTasksQueue? env? errorHandler? @@ -43,229 +8,35 @@ onlineHandler? restartWorkerOnError? settings? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? -
-
-

Properties

-
-

Optional enableEvents

-
enableEvents?: boolean
-

Pool events emission.

-
-
-

Default Value

true
+

Properties

Optional enableEvents

enableEvents?: boolean

Pool events integrated with async resource emission.

+

Default Value

true
-
-
-

Optional enableTasksQueue

-
enableTasksQueue?: boolean
-

Pool worker node tasks queue.

-
-
-

Default Value

false
+

Optional enableTasksQueue

enableTasksQueue?: boolean

Pool worker node tasks queue.

+

Default Value

false
-
-
-

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

-
-
-

Optional errorHandler

-
errorHandler?: ErrorHandler<Worker>
-

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

-
-
-
-

Optional exitHandler

-
exitHandler?: ExitHandler<Worker>
-

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

-
-
-
-

Optional messageHandler

-
messageHandler?: MessageHandler<Worker>
-

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

-
-
-
-

Optional onlineHandler

-
onlineHandler?: OnlineHandler<Worker>
-

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

-
-
-
-

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

+

Optional errorHandler

errorHandler?: ErrorHandler<Worker>

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

+

Default Value

() => {}

+

Optional exitHandler

exitHandler?: ExitHandler<Worker>

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

+

Default Value

() => {}

+

Optional messageHandler

messageHandler?: MessageHandler<Worker>

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

+

Default Value

() => {}

+

Optional onlineHandler

onlineHandler?: OnlineHandler<Worker>

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

+

Default Value

() => {}

+

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 startWorkers

startWorkers?: boolean

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

+

Default Value

true
-
-
-

Optional workerChoiceStrategyOptions

-
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
-

The worker choice strategy options.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Optional tasksQueueOptions

tasksQueueOptions?: TasksQueueOptions

Pool worker node 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

The worker choice strategy options.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file