X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=f30fbd10ed85d6b955926015bcfeff6139f44b62;hb=88af9bf11e70a785747f7511e26d13355ba9deb7;hp=60c8b9170be2b789fdffa76d4ba5f5d8bed997fe;hpb=e5c1b3572e6fe4cd11b32742c37039f3a6b3c373;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index 60c8b917..f30fbd10 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,5 +1,5 @@ -ThreadPoolOptions | poolifier - v3.0.13

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? +ThreadPoolOptions | poolifier - v3.0.14

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? enableTasksQueue? errorHandler? exitHandler? @@ -14,26 +14,26 @@

Properties

Optional enableEvents

enableEvents?: boolean

Pool events integrated with async resource emission.

Default Value

true
-

Optional enableTasksQueue

enableTasksQueue?: boolean

Pool worker node tasks queue.

+

Optional enableTasksQueue

enableTasksQueue?: boolean

Pool worker node tasks queue.

Default Value

false
-

Optional errorHandler

errorHandler?: ErrorHandler<Worker>

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

+

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.

+

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.

+

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.

+

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 startWorkers

startWorkers?: boolean

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

+

Optional restartWorkerOnError

restartWorkerOnError?: boolean

Restart worker on error.

+

Optional startWorkers

startWorkers?: boolean

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

Default Value

true
-

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.

+

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.

-

Optional workerOptions

workerOptions?: WorkerOptions

Worker options.

+

Optional workerChoiceStrategyOptions

workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

+

Optional workerOptions

workerOptions?: WorkerOptions

Worker options.

See

https://nodejs.org/api/worker_threads.html#new-workerfilename-options

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file