X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=6060dcf98316d0a323458ee1b9939bb1a0c81d3a;hb=e5c1b3572e6fe4cd11b32742c37039f3a6b3c373;hp=b30eb52e8414a14902ada60e2ded464e892c2646;hpb=c8a9d1714b7b1d592a73751ad6f580121cf75f7f;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index b30eb52e..6060dcf9 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,245 +1,37 @@ -PoolOptions | poolifier - v2.6.38
-
- -
-
-
-
- -

Interface PoolOptions<Worker>

-
-

Options for a poolifier pool.

-
-
-
-

Type Parameters

-
    -
  • -

    Worker extends IWorker

    -

    Type of worker.

    -
    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
enableEvents? +PoolOptions | poolifier - v3.0.13

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? messageHandler? onlineHandler? restartWorkerOnError? +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 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 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 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 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