X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=daa041701fac4721983350d88ec762dc62aba92f;hb=ef58d1c56c04f43dc88a76ef35d0127fe2bab27d;hp=d82e2149d127c66f58a9c7369afae2fe997bb791;hpb=f9fc489a415da7131735b04b0af50b1143dbdf70;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index d82e2149..daa04170 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,5 +1,5 @@ -ThreadPoolOptions | poolifier - v3.0.5

Interface ThreadPoolOptions

Options for a poolifier thread pool.

-

Hierarchy

Properties

enableEvents? +ThreadPoolOptions | poolifier - v3.0.9

Interface ThreadPoolOptions

Options for a poolifier thread pool.

+
interface ThreadPoolOptions {
    enableEvents?: boolean;
    enableTasksQueue?: boolean;
    errorHandler?: ErrorHandler<Worker>;
    exitHandler?: ExitHandler<Worker>;
    messageHandler?: MessageHandler<Worker>;
    onlineHandler?: OnlineHandler<Worker>;
    restartWorkerOnError?: boolean;
    startWorkers?: boolean;
    tasksQueueOptions?: TasksQueueOptions;
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
    workerOptions?: WorkerOptions;
}

Hierarchy

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

-
startWorkers?: boolean

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

+
restartWorkerOnError?: boolean

Restart worker on error.

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

-
workerOptions?: WorkerOptions

Worker options.

+
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

+
workerOptions?: WorkerOptions

Worker options.

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file