X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=d62f70d26d0d1624e21b1800e2dd7931c66d8c9a;hb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;hp=82abc2bc5a7c50a2464e6db1bd0ae67a7d364f38;hpb=3c7c9bd12cf4b0cec0e0a3825c31f7cc9f3f58fe;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 82abc2bc..d62f70d2 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.21
+FixedClusterPool | poolifier - v2.6.24
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.21
+
  • The search index is not available
    • poolifier - v2.6.24
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -169,7 +169,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -187,7 +187,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -201,7 +201,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -219,7 +219,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

    @@ -234,7 +234,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:130

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

      - +

    • Executes the specified function in the worker constructor with the task data input parameter.

      @@ -533,12 +533,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 +551,7 @@ Can be overridden.

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • Protected internalBusy

    • -

      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:623

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -859,7 +864,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -