X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=81c810c16aae3b4668660ce7d0381ece0af9986f;hb=120c7852afd1ce4c01bd7e70cd14eeeedda8c1e3;hp=de3365bb6a6b661d1426de672c8d9d6104be3001;hpb=d5d8ef5b0645ff2e43010f981a768c48cd559854;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index de3365bb..81c810c1 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier - v2.6.16
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.16
    @@ -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,7 +73,9 @@ When the maximum number of workers is reached and workers are busy, an event is info maxSize minSize +ready type +utilization worker
    @@ -81,6 +83,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -140,7 +143,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

    @@ -149,8 +152,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.
    @@ -158,7 +162,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:63

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number
    @@ -175,7 +179,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
    @@ -184,7 +188,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 opts

    opts: ClusterPoolOptions = {}
    @@ -193,7 +197,7 @@ 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>> = ...
    @@ -207,7 +211,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected workerChoiceStrategyContext

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

    • Accessors

    @@ -240,7 +244,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:586

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    Private ready

    +

    Protected type

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

    Private utilization

    +

    Protected worker

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

    • Methods

    @@ -342,7 +368,7 @@ Can be overridden.

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    Protected checkDynamicPoolSize

    +

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1071
    • @@ -701,11 +743,14 @@ Can be overridden.

  • info
  • maxSize
  • minSize
    • +
  • ready
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • +
  • checkDynamicPoolSize
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
    • @@ -722,7 +767,7 @@ Can be overridden.

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

    • Generated using TypeDoc

    \ No newline at end of file