X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=4332af1394df411673cc8860c5bcfe4a1f85ca3f;hb=3c7c9bd12cf4b0cec0e0a3825c31f7cc9f3f58fe;hp=847f0fe9912a481302ca92d268c2671675a432c9;hpb=85c03385d4a5d06c979104ae7e96d68b2301d10a;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 847f0fe9..4332af13 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier - v2.6.11
+DynamicThreadPool | poolifier - v2.6.21
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.11
+
  • The search index is not available
    • poolifier - v2.6.21
    @@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:15
    • @@ -74,7 +74,6 @@ When the maximum number of threads is reached and workers are busy, an event is maxSize minSize ready -starting type utilization worker @@ -82,18 +81,22 @@ When the maximum number of threads 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 +registerWorkerMessageListener +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -144,7 +147,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:27

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly max

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -198,11 +201,11 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:48

    • 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 +215,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:74

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

    • get maxSize(): number
    • -

      Pool maximum size.

      +

      The pool maximum size.

      Returns number

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

    • Protected minSize

    • get minSize(): number
    • -

      Pool minimum size.

      +

      The pool minimum size.

      Returns number

    +
  • Defined in src/pools/thread/fixed.ts:130

    • Private ready

    • get ready(): boolean
    • -

      Returns boolean

    -
    -

    Private starting

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

    • 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/thread/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:461

    • 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/thread/fixed.ts:125

    • Methods

    Protected afterTaskExecutionHook

      - +

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

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

      Parameters

    -
    -

    Protected afterWorkerSetup

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

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

    -
    -

    Protected createAndSetupDynamicWorker

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

    Protected createAndSetupDynamicWorkerNode

    -
    -

    Protected createAndSetupWorker

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

    Protected createAndSetupWorkerNode

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

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:112

    • destroy

    -
    -

    Protected destroyWorker

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

    Protected destroyWorkerNode

    +
  • Defined in src/pools/thread/fixed.ts:59

    • enableTasksQueue

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

    • execute

      @@ -550,12 +547,12 @@ Can be overridden.

      • Optional data: Data
        -

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

        +

        The 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 name of the task function to execute. If not specified, the default task function will be executed.

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    @@ -563,7 +560,42 @@ Can be overridden.

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

    Protected flushTasksQueue

    +
    +
    +

    Protected getWorkerInfo

    +

    Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:54
    • +
    +

    Protected registerWorkerMessageListener

    +
    +
    +

    Protected sendStartupMessageToWorker

    +

    Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:76

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1034
    • @@ -754,23 +847,26 @@ 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
    • +
  • registerWorkerMessageListener
    • +
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
    • @@ -778,7 +874,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -