X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=a28b464723853f1775d60cf99e77c400b2455d07;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=6ecf7c136e264fad16863ad40a623d58c4fec6d9;hpb=52f4e8137eab5d72c663eb9ae9289c08d804e559;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 6ecf7c13..a28b4647 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.6.12
+DynamicClusterPool | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.12
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
    • @@ -74,7 +74,6 @@ When the maximum number of workers is reached and workers are busy, an event is maxSize minSize ready -starting type utilization worker @@ -82,18 +81,24 @@ When the maximum number of workers is reached and workers are busy, an event is

    Methods

    afterTaskExecutionHook -afterWorkerSetup +afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize -createAndSetupDynamicWorker -createAndSetupWorker +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode createWorker destroy -destroyWorker +destroyWorkerNode enableTasksQueue execute +flushTasksQueue +getWorkerInfo internalBusy isMain +listTaskFunctions +registerWorkerMessageListener +sendKillMessageToWorker +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -144,7 +149,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:27

    • Properties

    @@ -163,7 +168,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -172,7 +177,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:109

    • Protected Readonly max

    max: number
    @@ -180,7 +185,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:29

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -189,7 +194,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:108

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -198,11 +203,11 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    -
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    -

    The execution response promise map.

    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    +

    The task execution response promise map.

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.
      • @@ -212,7 +217,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -221,7 +226,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -230,7 +235,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

    @@ -245,7 +250,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:48

    • Protected full

      @@ -258,7 +263,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:613

    • info

      @@ -270,93 +275,87 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:308

    • Protected maxSize

    • get maxSize(): number
    • -

      Pool maximum size.

      +

      The pool maximum size.

      Returns number

    +
  • Defined in src/pools/cluster/dynamic.ts:43

    • Protected minSize

    • get minSize(): number
    • -

      Pool minimum size.

      +

      The pool minimum size.

      Returns number

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

    • Private ready

    • get ready(): boolean
    • -

      Returns boolean

    -
    -

    Private starting

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

    • Protected type

    • get type(): "fixed" | "dynamic"
    • -

      Pool type.

      +

      The pool type.

      If it is 'dynamic', it provides the max property.

      Returns "fixed" | "dynamic"

    +
  • Defined in src/pools/cluster/dynamic.ts:38

    • Private utilization

    • get utilization(): number
    • -

      Gets the approximate pool utilization.

      +

      The approximate pool utilization.

      Returns number

      The pool utilization.

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

    • Protected worker

      -
    • get worker(): "cluster" | "thread"
      • +
    • get worker(): "thread" | "cluster"
    • -

      Gets the worker type.

      +

      The worker type.

      -

      Returns "cluster" | "thread"

      +

      Returns "thread" | "cluster"

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

    • Methods

    Protected afterTaskExecutionHook

      - +

    • Hook executed after the worker task execution. Can be overridden.

      @@ -365,8 +364,8 @@ Can be overridden.

      Parameters

    -
    -

    Protected afterWorkerSetup

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

    Protected afterWorkerNodeSetup

      - +
    • -

      Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +

      Method hooked up after a worker node has been newly created. Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The newly created worker.

        +
        workerNodeKey: number
        +

        The newly created worker node key.

      Returns void

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

    -
    -

    Protected createAndSetupDynamicWorker

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

    Protected createAndSetupDynamicWorkerNode

    -
    -

    Protected createAndSetupWorker

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

    Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

    -
    -

    Protected destroyWorker

    +
  • 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.

      @@ -550,12 +549,17 @@ Can be overridden.

      • Optional data: Data
        -

        The task input data for the specified worker 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 worker function to execute. If not specified, the default worker 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.

    @@ -563,20 +567,55 @@ Can be overridden.

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

    Protected flushTasksQueue

    +
    +
    +

    Protected getWorkerInfo

    +

    Protected internalBusy

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

    • Protected isMain

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

    listTaskFunctions

    +
    +
    +

    Protected registerWorkerMessageListener

    +
    +
    +

    Protected sendKillMessageToWorker

    +
    +
    +

    Protected sendStartupMessageToWorker

    +

    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:1108
    • @@ -754,23 +883,28 @@ Can be overridden.

  • maxSize
  • minSize
  • ready
    • -
  • starting
  • type
  • utilization
  • worker
  • afterTaskExecutionHook
    • -
  • afterWorkerSetup
    • +
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
  • checkDynamicPoolSize
    • -
  • createAndSetupDynamicWorker
    • -
  • createAndSetupWorker
    • +
  • createAndSetupDynamicWorkerNode
    • +
  • createAndSetupWorkerNode
  • createWorker
  • destroy
    • -
  • destroyWorker
    • +
  • destroyWorkerNode
  • enableTasksQueue
  • execute
    • +
  • flushTasksQueue
    • +
  • getWorkerInfo
  • internalBusy
  • isMain
    • +
  • listTaskFunctions
    • +
  • registerWorkerMessageListener
    • +
  • sendKillMessageToWorker
    • +
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
    • @@ -778,7 +912,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -