X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=0abe909a9c4e278f207b72ba0c95168fd747b856;hb=ef58d1c56c04f43dc88a76ef35d0127fe2bab27d;hp=e9e48ca9cbdc59d7ea6f63097d8a3cbd779d0902;hpb=078116c1d8dde66831fcf40973059818592c8a88;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index e9e48ca9..0abe909a 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ -PoolOptions | poolifier - v3.0.5

Interface PoolOptions<Worker>

Options for a poolifier pool.

-

Type Parameters

  • Worker extends IWorker

    Type of worker.

    -

Hierarchy

Properties

enableEvents? +PoolOptions | poolifier - v3.0.9

Interface PoolOptions<Worker>

Options for a poolifier pool.

+
interface PoolOptions {
    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;
}

Type Parameters

  • Worker extends IWorker

    Type of worker.

    +

Hierarchy

Properties

enableEvents? enableTasksQueue? errorHandler? exitHandler? @@ -14,24 +14,24 @@

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.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

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