X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=517fd93583c5c17aa2347b3a84185c4f2948b069;hb=04212af7b1a1494ff58da58c9e5b3397d25f18b7;hp=bd89a3e6c09ae07ecf8357859d0e6070d121f8bb;hpb=273b76d87560482b4114668a705e42d54b3ce3b0;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index bd89a3e6..517fd935 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,5 +1,5 @@ -ClusterPoolOptions | poolifier - v3.0.9

Interface ClusterPoolOptions

Options for a poolifier cluster pool.

-

Hierarchy

Properties

enableEvents? +ClusterPoolOptions | poolifier - v3.0.10

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

Properties

enableEvents?: boolean

Pool events integrated with async resource emission.

Default Value

true
 
-
enableTasksQueue?: boolean

Pool worker node tasks queue.

+
enableTasksQueue?: boolean

Pool worker node tasks queue.

Default Value

false
 
-
env?: Record<string, unknown>

Key/value pairs to add to worker process environment.

+
env?: Record<string, unknown>

Key/value pairs to add to worker process environment.

errorHandler?: ErrorHandler<Worker>

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

+
errorHandler?: ErrorHandler<Worker>

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

Default Value

() => {}

-
exitHandler?: ExitHandler<Worker>

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

+
exitHandler?: ExitHandler<Worker>

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

Default Value

() => {}

-
messageHandler?: MessageHandler<Worker>

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

+
messageHandler?: MessageHandler<Worker>

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

Default Value

() => {}

-
onlineHandler?: OnlineHandler<Worker>

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

+
onlineHandler?: OnlineHandler<Worker>

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

Default Value

() => {}

-
restartWorkerOnError?: boolean

Restart worker on error.

-
settings?: ClusterSettings

Cluster settings.

+
restartWorkerOnError?: boolean

Restart worker on error.

+
settings?: ClusterSettings

Cluster settings.

startWorkers?: boolean

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

+
startWorkers?: boolean

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

Default Value

true
 
-
tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

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

+
tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

+
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
 
-
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

-

Generated using TypeDoc

\ No newline at end of file +
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

+

Generated using TypeDoc

\ No newline at end of file