X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=e73242a662a510823b93b9a8b0e269474d70960e;hb=23a6c28d3cc6edb778653a4d9d9a4d36f9a961c3;hp=34eaa0cd20bf308e57c087cf216bd6a77bf5c1b6;hpb=5497d426557f576e3ee314619f83b71685acc6bc;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 34eaa0cd..e73242a6 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | poolifier - v2.6.20
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.20
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -72,7 +72,7 @@ info maxSize minSize -runTime +ready type utilization worker @@ -80,17 +80,22 @@

    Methods

    afterTaskExecutionHook -afterWorkerSetup +afterWorkerNodeSetup beforeTaskExecutionHook -createAndSetupDynamicWorker -createAndSetupWorker +checkDynamicPoolSize +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode createWorker destroy -destroyWorker +destroyWorkerNode enableTasksQueue execute +flushTasksQueue +getWorkerInfo internalBusy isMain +registerWorkerMessageListener +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -136,7 +141,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -145,8 +150,9 @@

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and full.
      • -
    • 'busy': Emitted when the pool is busy.
      • +
    • '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.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    @@ -154,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:64

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -181,11 +187,11 @@
    +
  • 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.

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[] = []
    +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected minSize

    • get minSize(): number
    • -

      Pool minimum size.

      +

      The pool minimum size.

      Returns number

    -
    -

    Private runTime

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

    Private ready

      -
    • get runTime(): number
      • +
    • get ready(): boolean
    • -

      Gets the pool run time.

      +

      The pool readiness boolean status.

      -

      Returns number

      The pool run time in milliseconds.

      - +

      Returns boolean

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

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

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

    • Protected worker

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

      Gets the worker type.

      +

      The worker type.

      Returns "cluster" | "thread"

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

    • Methods

    Protected afterTaskExecutionHook

      - +

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

      @@ -343,8 +348,8 @@ Can be overridden.

      Parameters

    -
    -

    Protected afterWorkerSetup

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

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

    • Protected beforeTaskExecutionHook

    -
    -

    Protected createAndSetupDynamicWorker

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

    Protected checkDynamicPoolSize

      - +
    • -

      Creates a new dynamic worker and sets it up completely in the pool worker nodes.

      +
      +

      Parameters

      +
        +
      • +
        min: number
        • +
      • +
        max: number
      +

      Returns void

    +
    +

    Protected createAndSetupDynamicWorkerNode

    +
    -
    -

    Protected createAndSetupWorker

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

    Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

    -
    -

    Protected destroyWorker

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

    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 void

      +

      Returns Promise<void>

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

    • enableTasksQueue

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

    • execute

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

    Protected flushTasksQueue

    +
    +
    +

    Protected getWorkerInfo

    +

    Protected internalBusy

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

    • Protected isMain

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

    Protected registerWorkerMessageListener

    +
      + +
    • +

      Registers a listener callback on the worker given its worker node key.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        Message

      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
        • +
      • +
        listener: ((message) => void)
        +

        The message listener callback.

        +
        +
        +
          +
        • +
            +
          • (message): void
            • +
          • +
            +

            Parameters

            +
            +

            Returns void

      +

      Returns void

      +
    +
    +

    Protected sendStartupMessageToWorker

    +

    Protected sendToWorker

      - +
    • -

      Sends a message to the given worker.

      +

      Sends a message to worker given its worker node key.

      Parameters

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    • -

      This function is the listener registered for each worker message.

      +

      This method is the listener registered for each worker message.

      Returns ((message) => void)

      The listener function to execute when a message is received from a worker.

      @@ -668,7 +785,7 @@ Can be overridden.

      • (message): void
      • -

        This function is the listener registered for each worker message.

        +

        This method is the listener registered for each worker message.

        Parameters

        @@ -681,7 +798,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:1030
    • @@ -714,22 +831,27 @@ Can be overridden.

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

  • setupHook
  • workerListener
    • -