X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=111a48e0e5ceb5d810963161433a256d9dd399f4;hb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;hp=c220e4e5fa869366b3d1d485c1465920689a4da7;hpb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c220e4e5..111a48e0 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier - v2.6.23
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.23
    @@ -30,12 +30,12 @@ When the maximum number of workers is reached and workers are busy, an event is

    • Data = unknown

      -

      Type of data sent to the worker. This can only be serializable data.

      +

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      -

      Type of execution response. This can only be serializable data.

      +

      Type of execution response. This can only be structured-cloneable data.

    @@ -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
    • @@ -73,24 +73,30 @@ When the maximum number of workers is reached and workers are busy, an event is info maxSize minSize +ready type +utilization worker

    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 @@ -141,7 +147,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

    @@ -150,8 +156,9 @@ When the maximum number of workers is reached and workers are busy, an event is

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

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number
    @@ -176,7 +183,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
    @@ -185,7 +192,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:103

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -194,11 +201,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.
      • @@ -208,7 +215,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:74

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -217,16 +224,16 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • 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

    @@ -241,7 +248,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

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    Private ready

    +

    Protected type

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

    Private utilization

    +

    Protected worker

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

    • Methods

    Protected afterTaskExecutionHook

      - +

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

      @@ -330,12 +362,12 @@ Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        workerNodeKey: number
        +

        The worker node key.

      • -
        message: MessageValue<Response, unknown, Worker | MessagePort>
        +
        message: MessageValue<Response, unknown>

        The received message.

      @@ -343,28 +375,28 @@ Can be overridden.

    -
    -

    Protected afterWorkerSetup

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

    Protected afterWorkerNodeSetup

      - +
    • -

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

      -

      Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.

      +

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

    • Protected beforeTaskExecutionHook

    -
    -

    Protected createAndSetupDynamicWorker

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

    Protected checkDynamicPoolSize

    +
    +

    Protected createAndSetupDynamicWorkerNode

    +
    -
    -

    Protected createAndSetupWorker

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

    Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

    -
    -

    Protected destroyWorker

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

    Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    Protected flushTasksQueue

    +
    +
    +

    Protected getWorkerInfo

    +

    Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

    Returns void

    Returns void

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

    Protected sendStartupMessageToWorker

    +

    Protected sendToWorker

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

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1045
    • @@ -743,21 +846,27 @@ Can be overridden

  • info
  • maxSize
  • minSize
    • +
  • 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
    • @@ -765,7 +874,7 @@ Can be overridden

  • setupHook
  • workerListener
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file