X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=109004e98d6c1e413df01cdbbea7f700b7633d06;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=825f9e0c26004982d9da12ded0e2e21c825393bf;hpb=fb61ac734cb4236948a9c7b58fe55d2ca5665ef2;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 825f9e0c..109004e9 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,4 +1,4 @@ -ClusterPoolOptions | poolifier
+ClusterPoolOptions | poolifier
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier
    -
    +
    • poolifier
      • @@ -25,7 +25,7 @@
      • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -34,13 +34,16 @@

    Properties

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

    Properties

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

    Pool events emission.

    -

    Default

    true

    +

    Default Value

    true

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

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    + +

    Default Value

    false

    +

    Optional env

    env?: any
    @@ -62,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>
    @@ -70,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:75

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -94,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:79

    • Optional settings

    settings?: ClusterSettings
    @@ -103,19 +116,38 @@

    See

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

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

    Optional 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.

    + +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

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

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -126,25 +158,65 @@

    • 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