X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=ac2afe4a6c15b6e8beb240cffaafb2ef501a5a6f;hb=e39450c0889208d6dcde666fc05b95fe7a98ee29;hp=0274056287b5db3ac06a776b2d0dfc8882558dd7;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 02740562..ac2afe4a 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,19 +1,217 @@ -ClusterPoolOptions | poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClusterPoolOptions

-

Options for a poolifier cluster pool.

-

Hierarchy

Index

Properties

Optional enableEvents

enableEvents?: boolean
-

Pool events emission.

-
default

true

-

Optional env

env?: any
-

Key/value pairs to add to worker process environment.

-
see

https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

-

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 workerChoiceStrategy

workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
-

The work choice strategy to use in this pool.

-

Generated using TypeDoc

\ No newline at end of file +ClusterPoolOptions | poolifier
+
+ +
+
+
+
+ +

Interface ClusterPoolOptions

+
+

Options for a poolifier cluster pool.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
enableEvents?: boolean
+

Pool events emission.

+ +

Default Value

true

+
+
+ +
enableTasksQueue?: boolean
+

Pool worker tasks queue.

+ +

Default Value

false

+
+
+ +
env?: any
+

Key/value pairs to add to worker process environment.

+ +

See

https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

+
+
+ +
errorHandler?: ErrorHandler<Worker>
+

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

+
+
+ +
exitHandler?: ExitHandler<Worker>
+

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

+
+
+ +
messageHandler?: MessageHandler<Worker>
+

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

+
+
+ +
onlineHandler?: OnlineHandler<Worker>
+

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

+
+
+ +
settings?: ClusterSettings
+
+
+ +
tasksQueueOptions?: TasksQueueOptions
+

Pool worker tasks queue options.

+
+
+ +
workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+

The worker choice strategy to use in this pool.

+
+
+ +
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+

The worker choice strategy options.

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file