FixedClusterPool | poolifier - v2.6.11

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=e73242a662a510823b93b9a8b0e269474d70960e;hb=23a6c28d3cc6edb778653a4d9d9a4d36f9a961c3;hp=e27858d6f1c9e7c69afd0cd82a14ccfab165ec53;hpb=85c03385d4a5d06c979104ae7e96d68b2301d10a;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index e27858d6..e73242a6 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.11

+FixedClusterPool | poolifier - v2.6.20

@@ -45,7 +45,7 @@

DynamicClusterPool

+

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

@@ -73,7 +73,6 @@ maxSize minSize ready -starting type utilization worker @@ -81,18 +80,22 @@

+

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

Properties

@@ -157,7 +160,7 @@

+

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

`Protected` `Readonly` filePath

filePath: string

@@ -166,7 +169,7 @@

+

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -175,7 +178,7 @@

+

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

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

key: The message id of each submitted task.
value: An object that contains the worker, the execution response promise resolve and reject callbacks.

+

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -207,7 +210,7 @@

+

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

`Readonly` workerNodes

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

@@ -216,7 +219,7 @@

+

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

Accessors

@@ -231,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
Overrides AbstractPool.maxSize
- Defined in src/pools/cluster/fixed.ts:97

+

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

`Protected` minSize

get minSize(): number
-
Pool minimum size.
+
The pool minimum size.

Returns number
Overrides AbstractPool.minSize
- Defined in src/pools/cluster/fixed.ts:92

+

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

`Private` ready

get ready(): boolean
-
Returns boolean
+
The pool readiness boolean status.
+
+
Returns boolean
+
Inherited from AbstractPool.ready
- Defined in src/pools/abstract-pool.ts:412

-

-

`Private` starting

-

get starting(): boolean
-
Returns boolean
-
Inherited from AbstractPool.starting
-
- Defined in src/pools/abstract-pool.ts:404

+

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"
Overrides AbstractPool.type
- Defined in src/pools/cluster/fixed.ts:82

+

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.
Inherited from AbstractPool.utilization
- Defined in src/pools/abstract-pool.ts:424

+

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

`Protected` worker

get worker(): "cluster" | "thread"
-
Gets the worker type.
+
The worker type.

Returns "cluster" | "thread"
Overrides AbstractPool.worker
- Defined in src/pools/cluster/fixed.ts:87

+

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

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker, message): void
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution. Can be overridden.
@@ -351,8 +348,8 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -364,28 +361,28 @@ Can be overridden.
  Inherited from AbstractPool.afterTaskExecutionHook
  - Defined in src/pools/abstract-pool.ts:683

-

-

`Protected` afterWorkerSetup

+

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

+

+

`Protected` afterWorkerNodeSetup

afterWorkerSetup(worker): void
afterWorkerNodeSetup(workerNodeKey): void
-
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
-
Inherited from AbstractPool.afterWorkerSetup
+
Inherited from AbstractPool.afterWorkerNodeSetup
- Defined in src/pools/abstract-pool.ts:911

+

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

`Protected` beforeTaskExecutionHook

+

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

`Protected` checkDynamicPoolSize

Returns void

-

-

`Protected` createAndSetupDynamicWorker

+

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

+

+

`Protected` createAndSetupDynamicWorkerNode

createAndSetupDynamicWorker(): Worker
createAndSetupDynamicWorkerNode(): number
-
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up dynamic worker node.

-
Returns Worker
New, completely set up dynamic worker.
+
Returns number
New, completely set up dynamic worker node key.
-
Inherited from AbstractPool.createAndSetupDynamicWorker
+
Inherited from AbstractPool.createAndSetupDynamicWorkerNode
- Defined in src/pools/abstract-pool.ts:994

-

-

`Protected` createAndSetupWorker

+

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

+

+

`Protected` createAndSetupWorkerNode

createAndSetupWorker(): Worker
createAndSetupWorkerNode(): number
-
Creates a new worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up worker node.

-
Returns Worker
New, completely set up worker.
+
Returns number
New, completely set up worker node key.
-
Inherited from AbstractPool.createAndSetupWorker
+
Inherited from AbstractPool.createAndSetupWorkerNode
- Defined in src/pools/abstract-pool.ts:928

+

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

`Protected` createWorker

+

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

destroy

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

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

-

-

`Protected` destroyWorker

+

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

+

+

`Protected` destroyWorkerNode

destroyWorker(worker): void
destroyWorkerNode(workerNodeKey): Promise<void>
-
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>
-
Overrides AbstractPool.destroyWorker
+
Overrides AbstractPool.destroyWorkerNode
- Defined in src/pools/cluster/fixed.ts:63

+

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

+

flushTasksQueue(workerNodeKey): void
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns void
+
Inherited from AbstractPool.flushTasksQueue
+
- Defined in src/pools/abstract-pool.ts:1157

+

+

`Protected` getWorkerInfo

+

getWorkerInfo(workerNodeKey): WorkerInfo
+
Gets the worker information given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Inherited from AbstractPool.getWorkerInfo
+
- Defined in src/pools/abstract-pool.ts:1096

`Protected` internalBusy

+

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

`Protected` isMain

+

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

+

+

`Protected` registerWorkerMessageListener

+

registerWorkerMessageListener<Message>(workerNodeKey, listener): void
+
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
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Overrides AbstractPool.registerWorkerMessageListener
+
- Defined in src/pools/cluster/fixed.ts:97

+

+

`Protected` sendStartupMessageToWorker

+

sendStartupMessageToWorker(workerNodeKey): void
+
Sends the startup message to worker given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns void
+
+
Overrides AbstractPool.sendStartupMessageToWorker
+
- Defined in src/pools/cluster/fixed.ts:89

`Protected` sendToWorker

sendToWorker(worker, message): void
sendToWorker(workerNodeKey, message): void
-
Sends a message to the given worker.
+
Sends a message to worker given its worker node key.
Parameters
- -
  worker: Worker
  -
  The worker which should receive the message.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -599,7 +692,7 @@ Can be overridden.
  Overrides AbstractPool.sendToWorker
  
  -
  Defined in src/pools/cluster/fixed.ts:72

+

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

workerListener(): ((message) => void)
-
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.
@@ -692,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
  @@ -705,7 +798,7 @@ Can be overridden.
  
  Inherited from AbstractPool.workerListener
  
  -
  Defined in src/pools/abstract-pool.ts:1025

+

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