X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=047b3fc19bb9cb529ff97fa003ded05527c455de;hb=bb379737d9bdc595e5265c63c327260b9d15a201;hp=c7fc9ed3696045d1b8ae767000e084404c76a84a;hpb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index c7fc9ed3..047b3fc1 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.23
+FixedClusterPool | poolifier - v2.6.27
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.23
+
  • The search index is not available
    • poolifier - v2.6.27
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -94,7 +94,9 @@ getWorkerInfo internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -141,7 +143,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -150,9 +152,10 @@

    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.
    @@ -160,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • 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:451

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

      - +

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

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

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • Protected internalBusy

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

    • Protected isMain

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

    listTaskFunctions

    +

    Protected registerWorkerMessageListener

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

    Protected sendKillMessageToWorker

    +

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1109
    • @@ -850,7 +887,9 @@ Can be overridden.

  • getWorkerInfo
  • internalBusy
  • isMain
    • +
  • listTaskFunctions
  • registerWorkerMessageListener
    • +
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
    • @@ -859,7 +898,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -