X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=9893b5b7e4b1c6dc8b7fd38323e09d6813d93e4b;hb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;hp=20363fac1728005660f7fdb78bc36e26ef67ec8e;hpb=f1583b4edd427f8c3f2b4ddc652d2e102390b08e;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 20363fac..9893b5b7 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,13 +1,15 @@ -ClusterPoolOptions | poolifier
+ClusterPoolOptions | poolifier
-
+
-
+
  • poolifier
    • @@ -23,7 +25,7 @@
    • ClusterPoolOptions
+
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -32,12 +34,16 @@

    Properties

    enableEvents? +enableTasksQueue? env? errorHandler? exitHandler? messageHandler? onlineHandler? +settings? +tasksQueueOptions? workerChoiceStrategy? +workerChoiceStrategyOptions?

    Properties

    @@ -46,11 +52,21 @@
    enableEvents?: boolean

    Pool events emission.

    -

    Default

    true

    +

    Default Value

    true

    +
  • Defined in src/pools/pool.ts:77
    • +
    +

    Optional Experimental enableTasksQueue

    +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    + +

    Default Value

    false

    +

    Optional env

    env?: any
    @@ -59,7 +75,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:18

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -67,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:55

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -75,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:63

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -83,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:51

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -91,19 +107,45 @@
    +
  • Defined in src/pools/pool.ts:59
    • +
    +

    Optional settings

    +
    settings?: ClusterSettings
    +

    Cluster settings.

    + +

    See

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

    +
    +
    +

    Optional Experimental tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +

    Optional workerChoiceStrategy

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

    The worker choice strategy to use in this pool.

    -
    +
  • Defined in src/pools/pool.ts:67
    • +
    +

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -114,24 +156,49 @@

    • Theme

    - -
    -
    +
  • enableEvents
    • +
  • enableTasksQueue
    • +
  • env
    • +
  • errorHandler
    • +
  • exitHandler
    • +
  • messageHandler
    • +
  • onlineHandler
    • +
  • settings
    • +
  • tasksQueueOptions
    • +
  • workerChoiceStrategy
    • +
  • workerChoiceStrategyOptions
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file