X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=e0a6b5d08e7c81aeb5ccdfcac9da064e9634aa56;hb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;hp=92d3fe1e4acf37475868fbb92aaac1af17eb11e7;hpb=fe9f25b5ac98c7c7fccd1849a200c5054a77cf03;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 92d3fe1e..e0a6b5d0 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:99
    • +
    +

    Optional 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:75

    • Optional exitHandler

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

    • Optional messageHandler

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

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

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

    • Optional onlineHandler

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

    Optional settings

    +
    settings?: ClusterSettings
    +

    Cluster settings.

    + +

    See

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

    +
    +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
    -

    The work choice strategy to use in this pool.

    +
    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

    @@ -114,24 +158,62 @@

    • 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