X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=98f5c30d4c20f78c2b940cc01118016592505737;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=d4dc6e76b0887f32a68f5eb412b9b8c85a79ec16;hpb=8ad621cc1d32ed396fca3ef2ec48337e42d2dcc2;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index d4dc6e76..98f5c30d 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -FixedClusterPool | poolifier - v2.6.25
+FixedClusterPool | poolifier - v2.7.0
-
+
  • The search index is not available
  • poolifier - v2.7.0 +
    @@ -45,20 +45,21 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • - +

    Constructors

    - +
    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -150,17 +159,19 @@

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • -
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • +
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:69
  • filePath: string
    @@ -169,7 +180,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:124
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -178,7 +198,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:123
  • @@ -187,11 +207,11 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    -

    The task execution response promise map.

    +

    The task execution response promise map:

    +
  • Defined in src/pools/abstract-pool.ts:78
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,16 +230,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:84
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    +
  • Defined in src/pools/abstract-pool.ts:66
  • Accessors

    @@ -234,7 +254,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:123
  • +
  • Defined in src/pools/abstract-pool.ts:732
  • -
    +
  • Defined in src/pools/abstract-pool.ts:352
  • +
    -
      +
      • get maxSize(): number
      • The pool maximum size.

        Returns number

    -
    +
  • Defined in src/pools/abstract-pool.ts:565
  • +
    -
      +
      • get minSize(): number
      • The pool minimum size.

        Returns number

    +
  • Defined in src/pools/abstract-pool.ts:558
  • +
  • Defined in src/pools/abstract-pool.ts:510
  • +
  • Defined in src/pools/cluster/fixed.ts:113
  • +
  • Defined in src/pools/abstract-pool.ts:527
  • +
  • Defined in src/pools/cluster/fixed.ts:118
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1090
  • +
  • Defined in src/pools/abstract-pool.ts:1374
  • +
  • Defined in src/pools/abstract-pool.ts:1060
  • +
  • Defined in src/pools/abstract-pool.ts:197
  • +
  • Defined in src/pools/abstract-pool.ts:1307
  • +
  • Defined in src/pools/abstract-pool.ts:1263
  • +
  • Defined in src/pools/cluster/fixed.ts:108
  • +
  • Defined in src/pools/abstract-pool.ts:1000
  • +
  • Defined in src/pools/cluster/fixed.ts:63
    • -

      Enables/disables the worker tasks queue in this pool.

      +

      Enables/disables the worker node tasks queue in this pool.

      Parameters

      • enable: boolean
        -

        Whether to enable or disable the worker tasks queue.

        +

        Whether to enable or disable the worker node tasks queue.

      • Optional tasksQueueOptions: TasksQueueOptions
        -

        The worker tasks queue options.

        +

        The worker node tasks queue options.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:646
  • +
  • Defined in src/pools/abstract-pool.ts:930
  • +
  • Defined in src/pools/abstract-pool.ts:1697
  • +
  • Defined in src/pools/abstract-pool.ts:1613
  • +
    + +
      + +
    • +

      Whether the specified task function exists in this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns boolean

      true if the task function exists, false otherwise.

      + +
    +
    + +
      + +
    • Internal +

      Whether the worker node has back pressure (i.e. its tasks queue is full).

      +
      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
      +

      Returns boolean

      true if the worker node has back pressure, false otherwise.

      + +
    +
  • Defined in src/pools/abstract-pool.ts:748
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
    + +
    +
  • Defined in src/pools/cluster/fixed.ts:100
  • +
    + +
      + +
    • +

      Removes a task function from this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

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

      Sets the default task function in this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns Promise<boolean>

      true if the default task function was set, false otherwise.

      + +
    +
  • Defined in src/pools/abstract-pool.ts:660
  • +
  • Defined in src/pools/abstract-pool.ts:613
  • +
  • Defined in src/pools/abstract-pool.ts:632
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1525
  • @@ -826,6 +1000,7 @@ Can be overridden.

  • constructor
  • emitter
  • filePath
  • +
  • max
  • numberOfWorkers
  • opts
  • promiseResponseMap
  • @@ -834,12 +1009,13 @@ Can be overridden.

  • busy
  • full
  • info
  • -
  • maxSize
  • -
  • minSize
  • +
  • maxSize
  • +
  • minSize
  • ready
  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
  • @@ -853,78 +1029,48 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
  • +
  • hasTaskFunction
  • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • +
  • listTaskFunctionNames
  • registerWorkerMessageListener
  • +
  • removeTaskFunction
  • +
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • +
  • setDefaultTaskFunction
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • +
  • start
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file