X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=a28b464723853f1775d60cf99e77c400b2455d07;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=ae34f527d938c417ca34dfdb07def1ef26d6ab7f;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index ae34f527..a28b4647 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -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,32 @@ 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 -chooseWorkerNode -createAndSetupWorker +checkDynamicPoolSize +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode createWorker destroy -destroyWorker +destroyWorkerNode enableTasksQueue execute +flushTasksQueue +getWorkerInfo internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -141,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

    @@ -150,8 +158,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 +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
    @@ -168,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
    @@ -176,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
    @@ -185,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 = {}
    @@ -194,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.
      • @@ -208,26 +217,25 @@ 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>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

    @@ -242,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

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

    • info

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

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

      @@ -331,12 +364,12 @@ Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        workerNodeKey: number
        +

        The worker node key.

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

        The received message.

      @@ -344,32 +377,32 @@ Can be overridden.

    -
    -

    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.

      -

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

    • Protected beforeTaskExecutionHook

    Returns void

    -
    -

    Protected chooseWorkerNode

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

    Protected checkDynamicPoolSize

    +
    +

    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

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

    Returns void

    Returns void

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

    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
    • @@ -735,21 +882,29 @@ Can be overridden

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

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

    • Generated using TypeDoc

    \ No newline at end of file