DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0240eb0206dde171e5a201039290d00b63a824e3;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=de3365bb6a6b661d1426de672c8d9d6104be3001;hpb=a6d9dccfaf39e185c896747260d668fcb683a8ed;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index de3365bb..0240eb02 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier - v2.6.19

@@ -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 @@ -88,8 +91,12 @@ When the maximum number of workers is reached and workers are busy, an event is destroyWorker enableTasksQueue execute +getWorkerInfoByWorker +getWorkerNodeKey internalBusy isMain +registerWorkerMessageListener +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -140,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

@@ -149,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.

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

@@ -167,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:106

`Protected` `Readonly` max

max: number

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

@@ -184,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:105

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -193,7 +201,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 +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>

@@ -216,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:82

`Readonly` workerNodes

workerNodes: WorkerNode<Worker, Data>[] = []

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

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

Accessors

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

`Private` ready

get ready(): boolean
+
Returns boolean
+
Inherited from FixedClusterPool.ready
+
- Defined in src/pools/abstract-pool.ts:430

`Protected` type

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

`Private` utilization

get utilization(): number
+
Gets the approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
Inherited from FixedClusterPool.utilization
+
- Defined in src/pools/abstract-pool.ts:447

`Protected` worker

Defined in src/pools/cluster/fixed.ts:103

Methods

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

Defined in src/pools/abstract-pool.ts:717

`Protected` afterWorkerSetup

Defined in src/pools/abstract-pool.ts:941

`Protected` beforeTaskExecutionHook

Defined in src/pools/abstract-pool.ts:696

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
Inherited from FixedClusterPool.checkDynamicPoolSize
+
- Defined in src/pools/abstract-pool.ts:174

`Protected` createAndSetupDynamicWorker

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

`Protected` createAndSetupWorker

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

`Protected` createWorker

Defined in src/pools/cluster/fixed.ts:93

destroy

destroy(): Promise<void>
-
Terminate every current worker in this pool.
+
Terminates every current worker in this pool.

Returns Promise<void>
Inherited from FixedClusterPool.destroy
- Defined in src/pools/abstract-pool.ts:451

Defined in src/pools/abstract-pool.ts:651

`Protected` destroyWorker

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

enableTasksQueue

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

execute

Defined in src/pools/abstract-pool.ts:616

`Protected` getWorkerInfoByWorker

getWorkerInfoByWorker(worker): WorkerInfo
+
Gets the worker information from the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+
+
Inherited from FixedClusterPool.getWorkerInfoByWorker
+
- Defined in src/pools/abstract-pool.ts:1067

`Protected` getWorkerNodeKey

getWorkerNodeKey(worker): number
+
Gets the given worker its worker node key.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns number
The worker node key if found in the pool worker nodes, -1 otherwise.
+ +
+
Inherited from FixedClusterPool.getWorkerNodeKey
+
- Defined in src/pools/abstract-pool.ts:519

`Protected` internalBusy

Defined in src/pools/abstract-pool.ts:607

`Protected` isMain

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

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
+
Registers a listener callback on the given worker.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should register a listener.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Inherited from FixedClusterPool.registerWorkerMessageListener
+
- Defined in src/pools/cluster/fixed.ts:85

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(worker): void
+
Sends the startup message to the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should receive the startup message.
  +
  +
+
Returns void
+
+
Inherited from FixedClusterPool.sendStartupMessageToWorker
+
- Defined in src/pools/cluster/fixed.ts:77