X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=9e8a6b1c161b38c61e23b05784e835bee6af5ffc;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=a4a272b70f3eca7faa11a45859de6cdf166d38a6;hpb=76b46937556ea55049d5c413aa0a77d0c7f47f48;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a4a272b7..9e8a6b1c 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.19
+FixedThreadPool | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.19
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
    • @@ -80,21 +80,23 @@

    Methods

    afterTaskExecutionHook -afterWorkerSetup +afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize -createAndSetupDynamicWorker -createAndSetupWorker +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode createWorker destroy -destroyWorker +destroyWorkerNode enableTasksQueue execute -getWorkerInfoByWorker -getWorkerNodeKey +flushTasksQueue +getWorkerInfo internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -141,7 +143,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -187,11 +189,11 @@
    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected promiseResponseMap

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

    The execution response promise map.

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

    The task execution response promise map.

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -234,7 +236,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:142

    • Protected full

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

    • info

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

    • Protected minSize

    • get minSize(): number
    • -

      Pool minimum size.

      +

      The pool minimum size.

      Returns number

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

    • Private ready

    • get ready(): boolean
    • -

      Returns boolean

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

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

    • Methods

    Protected afterTaskExecutionHook

      - +

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

      @@ -345,8 +350,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/thread/fixed.ts:114

    • destroy

    -
    -

    Protected destroyWorker

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

    Protected destroyWorkerNode

      - +
    • -

      Terminates the given worker.

      +

      Terminates the worker node given its worker node key.

      Parameters

      • -
        worker: Worker
        -

        A worker within workerNodes.

        +
        workerNodeKey: number
        +

        The worker node key.

      Returns Promise<void>

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

    • enableTasksQueue

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

    • execute

      - +

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

      @@ -530,12 +535,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.

    @@ -543,64 +553,55 @@ Can be overridden.

    -
    -

    Protected getWorkerInfoByWorker

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

    Protected flushTasksQueue

    +

    Returns void

    -
    -

    Protected getWorkerNodeKey

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

    Protected getWorkerInfo

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

    • Protected internalBusy

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

    • Protected isMain

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

    listTaskFunctions

    +

    Protected registerWorkerMessageListener

    +
    +

    Protected sendKillMessageToWorker

    +

    Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • 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/abstract-pool.ts:755

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1108
    • @@ -842,21 +877,23 @@ Can be overridden.

  • utilization
  • worker
  • afterTaskExecutionHook
    • -
  • afterWorkerSetup
    • +
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
  • checkDynamicPoolSize
    • -
  • createAndSetupDynamicWorker
    • -
  • createAndSetupWorker
    • +
  • createAndSetupDynamicWorkerNode
    • +
  • createAndSetupWorkerNode
  • createWorker
  • destroy
    • -
  • destroyWorker
    • +
  • destroyWorkerNode
  • enableTasksQueue
  • execute
    • -
  • getWorkerInfoByWorker
    • -
  • getWorkerNodeKey
    • +
  • flushTasksQueue
    • +
  • getWorkerInfo
  • internalBusy
  • isMain
    • +
  • listTaskFunctions
  • registerWorkerMessageListener
    • +
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
    • @@ -865,7 +902,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -