X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=4738a04d6e29cce5cd52e342377c437c20928b8a;hb=c22b117f8593bba575a4385b8f125f14b4bf1099;hp=82abc2bc5a7c50a2464e6db1bd0ae67a7d364f38;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 82abc2bc..4738a04d 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.21
+FixedClusterPool | poolifier - v2.6.29
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.21
+
  • The search index is not available
  • poolifier - v2.6.29
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • @@ -92,9 +92,12 @@ execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -141,7 +144,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -150,17 +153,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.
    • +
    • '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 >= pool maximum size^2).
    +
  • Defined in src/pools/abstract-pool.ts:65
  • filePath: string
    @@ -169,7 +174,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • numberOfWorkers: number
    @@ -178,7 +183,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • @@ -187,7 +192,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -201,7 +206,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,16 +215,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:81
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -234,7 +239,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:130
  • +
  • Defined in src/pools/abstract-pool.ts:631
  • +
  • Defined in src/pools/abstract-pool.ts:321
  • +
  • Defined in src/pools/cluster/fixed.ts:125
  • +
  • Defined in src/pools/cluster/fixed.ts:120
  • +
  • Defined in src/pools/abstract-pool.ts:464
  • +
  • Defined in src/pools/cluster/fixed.ts:110
  • +
  • Defined in src/pools/abstract-pool.ts:481
  • +
  • Defined in src/pools/cluster/fixed.ts:115
  • Methods

    @@ -361,7 +366,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:818
  • +
  • Defined in src/pools/abstract-pool.ts:1081
  • +
  • Defined in src/pools/abstract-pool.ts:795
  • +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/abstract-pool.ts:1028
  • +
  • Defined in src/pools/abstract-pool.ts:988
  • +
  • Defined in src/pools/cluster/fixed.ts:105
  • +
  • Defined in src/pools/abstract-pool.ts:741
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:596
    • - +
    • Executes the specified function in the worker constructor with the task data input parameter.

      @@ -533,12 +538,17 @@ Can be overridden.

      • Optional data: Data
        -

        The task input data for the specified task function. This can only be structured-cloneable data.

        +

        The optional task input data for the specified task function. This can only be structured-cloneable data.

      • Optional name: string
        -

        The name of the task function to execute. If not specified, the default task function will be executed.

        +

        The optional name of the task function to execute. If not specified, the default task function will be executed.

        +
        +
      • +
      • +
        Optional transferList: TransferListItem[]
        +

        An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    @@ -546,7 +556,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:681
  • +
  • Defined in src/pools/abstract-pool.ts:1327
  • +
  • Defined in src/pools/abstract-pool.ts:1241
  • +
    + +
      + +
    • 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.

      + +
    • -

      Whether worker nodes are executing at least one task.

      +

      Whether worker nodes are executing concurrently their tasks quota or not.

      Returns boolean

      Worker nodes busyness boolean status.

    +
  • Defined in src/pools/abstract-pool.ts:647
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
    + +
    +
  • Defined in src/pools/cluster/fixed.ts:97
  • +
    + +
    +
  • Defined in src/pools/cluster/fixed.ts:89
  • +
  • Defined in src/pools/cluster/fixed.ts:81
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • +
  • Defined in src/pools/abstract-pool.ts:582
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1164