X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=e577eba9ec89f43f998bf05516222da86c571d00;hb=21402562176f7550bcd9ba620cf551972fca6e98;hp=0fcdc4ccc02f2cdf0249c85164582b2b69721bf6;hpb=fe9f25b5ac98c7c7fccd1849a200c5054a77cf03;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0fcdc4cc..e577eba9 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,13 @@
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
- -emitter
.Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
.Author
Christopher Quadflieg
@@ -30,9 +28,13 @@ When the maximum number of workers is reached, an event is emitted. If you wantType Parameters
Data = unknown
Data = unknown
+Type of data sent to the worker. This can only be serializable data.
+Response = unknown
Response = unknown
+Type of response of execution. This can only be serializable data.
+Hierarchy
@@ -40,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want- DynamicClusterPool
@@ -54,40 +56,36 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file Path
-max
-next Message Id
+max
number Of Workers
opts
-promise Map
-tasks
+promise Response Map
worker Choice Strategy Context
-workers
+worker Nodes
Properties
Accessors
Methods
-constructor
-- new
Dynamic Cluster Pool<Data, Response>(min: number, max: number, filePath: string, opts??: ClusterPoolOptions): DynamicClusterPool<Data, Response>
+- new
Dynamic Cluster Pool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>
-
@@ -125,95 +123,84 @@ When the maximum number of workers is reached, an event is emitted. If you want
-
-
Constructs a new poolifier dynamic cluster pool.
Path to an implementation of a
ClusterWorker
file, which can be relative or absolute.
+Optional
opts: ClusterPoolOptions = {}opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
+Properties
-Optional
Readonly
emitterInherit Doc
Path
-Readonly
fileReadonly
maxInherit Doc
Inherited from FixedClusterPool.max
--- Defined in src/pools/cluster/dynamic.ts:30
Message Id
-Protected
nextId of the next message.
+Maximum number of workers that can be created by this pool.
Inherited from FixedClusterPool.nextMessageId
-- Defined in src/pools/abstract-pool.ts:57
Of Workers
-Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedClusterPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:78
-Readonly
optsOptions for this fixed cluster pool.
+Inherited from FixedClusterPool.opts
-- Defined in src/pools/cluster/fixed.ts:47
Map
-Protected
promiseThe promise map.
+ Response Map
+Protected
promiseThe execution response promise map.
-
-
+
+
-key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
+When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Inherited from FixedClusterPool.promiseMap
--- Defined in src/pools/abstract-pool.ts:49
-Readonly
tasksInherit Doc
Inherited from FixedClusterPool.tasks
+Inherited from FixedClusterPool.promiseResponseMap
-- Defined in src/pools/abstract-pool.ts:33
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Inherited from FixedClusterPool.workerChoiceStrategyContext
-- Defined in src/pools/abstract-pool.ts:64
-Readonly
workers Nodes
+Readonly
workerInherit Doc
Inherited from FixedClusterPool.workers
+Inherited from FixedClusterPool.workerNodes
-- Defined in src/pools/abstract-pool.ts:30
Accessors
Returns boolean
Overrides FixedClusterPool.busy
-- Defined in src/pools/cluster/dynamic.ts:43
number Of Running Tasks
--- get numberOfRunningTasks(): number
+- Defined in src/pools/cluster/dynamic.ts:48
full
++- get full(): boolean
-
+
+
Inherit Doc
Returns boolean
Overrides FixedClusterPool.full
++- Defined in src/pools/cluster/dynamic.ts:43
Of Queued Tasks
+Private
number+- get numberOfQueuedTasks(): number
+-
+
+
+
Number of tasks queued in the pool.
+Returns number
Inherited from FixedClusterPool.numberOfQueuedTasks
++- Defined in src/pools/abstract-pool.ts:166
Of Running Tasks
+Private
number+- get numberOfRunningTasks(): number
+-
+
Number of tasks running in the pool.
+Returns number
Inherited from FixedClusterPool.numberOfRunningTasks
-- Defined in src/pools/abstract-pool.ts:150
type
@@ -248,9 +257,32 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns PoolType
Overrides FixedClusterPool.type
-- Defined in src/pools/cluster/dynamic.ts:38
Methods
+ Promise Response Hook
+Protected
after+- after
Promise Response Hook(worker: Worker, message: MessageValue<Response, unknown>): void
+-
+
+
+
+
+
Hook executed after the worker task promise resolution. +Can be overridden.
+Parameters
++-
+
+-
+
worker: Worker
+The worker.
+message: MessageValue<Response, unknown>
+The received message.
+Returns void
Inherited from FixedClusterPool.afterPromiseResponseHook
++- Defined in src/pools/abstract-pool.ts:309
Protected
after@@ -266,34 +298,53 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns void
Inherited from FixedClusterPool.afterWorkerSetup
-- Defined in src/pools/cluster/fixed.ts:89
Worker
+Protected
choose Promise Response Hook
+Protected
before+- before
Promise Response Hook(workerNodeKey: number): void
+-
+
+
+
+
+
Hook executed before the worker task promise resolution. +Can be overridden.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns void
Inherited from FixedClusterPool.beforePromiseResponseHook
++- Defined in src/pools/abstract-pool.ts:298
Protected
choose-- choose
Worker(): Worker
+- choose
Worker Node(): [number, WorkerNode<Worker, Data>]
-
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:342
And Setup Worker
- create
And Setup Worker(): Worker
-
-
+- Defined in src/pools/abstract-pool.ts:408
Worker
-
-
+- Defined in src/pools/cluster/fixed.ts:88
+- Defined in src/pools/abstract-pool.ts:261
+- Defined in src/pools/cluster/fixed.ts:69
-
-
-
-- Defined in src/pools/abstract-pool.ts:236
+
+
-
-
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:229
+
+ Busy
+- Defined in src/pools/abstract-pool.ts:221
Main
+- Defined in src/pools/cluster/fixed.ts:64
-
-
+- Defined in src/pools/cluster/fixed.ts:80
To Worker
+- Defined in src/pools/cluster/fixed.ts:75
+
Choose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker node key, worker node].
Returns Worker
Inherited from FixedClusterPool.chooseWorker
+Returns [number, WorkerNode<Worker, Data>]
Inherited from FixedClusterPool.chooseWorkerNode
-- Defined in src/pools/abstract-pool.ts:283
Protected
createCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
Returns
New, completely set up worker.
Returns Worker
Inherited from FixedClusterPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:337
Protected
create@@ -304,25 +355,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns Worker
Inherited from FixedClusterPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:84
Workers Tasks
-Protected
decrease-- decrease
Workers Tasks(worker: Worker): void
--
-
-
-
-
-
Decrease the number of tasks that the given worker has applied.
-Parameters
---
-
worker: Worker
-Worker whose tasks are decreased.
-Returns void
Inherited from FixedClusterPool.decreaseWorkersTasks
--- Defined in src/pools/abstract-pool.ts:246
destroy
@@ -333,7 +366,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns Promise<void>
Inherited from FixedClusterPool.destroy
-- Defined in src/pools/abstract-pool.ts:208
destroy Worker
@@ -349,7 +382,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns void
Inherited from FixedClusterPool.destroyWorker
-- Defined in src/pools/cluster/fixed.ts:65
execute
@@ -365,93 +398,27 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns Promise<Response>
Inherited from FixedClusterPool.execute
-- Defined in src/pools/abstract-pool.ts:196
find Free Worker
--- find
Free Worker(): false | Worker
--
-
-
-
-
Inherit Doc
Returns false | Worker
Inherited from FixedClusterPool.findFreeWorker
--- Defined in src/pools/abstract-pool.ts:185
get Worker Index
+find Free Worker Node Key
-- get
Worker Index(worker: Worker): number
+- find
Free Worker Node Key(): number
-
-
-
-
Inherit Doc
Parameters
---
-
worker: Worker
Returns number
Inherited from FixedClusterPool.getWorkerIndex
--- Defined in src/pools/abstract-pool.ts:160
get Worker Running Tasks
--- get
Worker Running Tasks(worker: Worker): undefined | number
--
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: Worker
Returns undefined | number
Inherited from FixedClusterPool.getWorkerRunningTasks
--- Defined in src/pools/abstract-pool.ts:155
Workers Task
-Protected
increase-- increase
Workers Task(worker: Worker): void
--
-
-
-
-
-
Increase the number of tasks that the given worker has applied.
-Parameters
---
-
worker: Worker
-Worker whose tasks are increased.
-Returns void
Inherited from FixedClusterPool.increaseWorkersTask
--- Defined in src/pools/abstract-pool.ts:237
Execute
-Protected
internal-- internal
Execute(worker: Worker, messageId: number): Promise<Response>
--
-
-
-
-
Parameters
---
-
--
-
worker: Worker
messageId: number
Returns Promise<Response>
Inherited from FixedClusterPool.internalExecute
+Inherited from FixedClusterPool.findFreeWorkerNodeKey
-- Defined in src/pools/abstract-pool.ts:308
Get Busy Status
+Protected
internalProtected
internal-- internal
Get Busy Status(): boolean
+- internal
Busy(): boolean
-
-
Returns boolean
Inherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:177
Protected
is@@ -462,7 +429,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns boolean
Inherited from FixedClusterPool.isMain
-- Defined in src/pools/cluster/fixed.ts:60
register Worker Message Listener
@@ -496,25 +463,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns void
Inherited from FixedClusterPool.registerWorkerMessageListener
-- Defined in src/pools/cluster/fixed.ts:76
Worker
-Protected
remove-- remove
Worker(worker: Worker): void
--
-
-
-
-
-
Removes the given worker from the pool.
-Parameters
---
-
worker: Worker
-Worker that will be removed.
-Returns void
Inherited from FixedClusterPool.removeWorker
--- Defined in src/pools/abstract-pool.ts:270
Protected
send@@ -532,11 +481,11 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns void
Inherited from FixedClusterPool.sendToWorker
-- Defined in src/pools/cluster/fixed.ts:71
set Worker Choice Strategy
-- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void
+- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
-
@@ -544,11 +493,11 @@ When the maximum number of workers is reached, an event is emitted. If you want
-
-
Inherit Doc
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:165
Protected
setup@@ -559,13 +508,13 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns void
Inherited from FixedClusterPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:53
Protected
workerThis function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Returns void
Inherited from FixedClusterPool.workerListener
-- Defined in src/pools/abstract-pool.ts:361
@@ -616,34 +565,30 @@ When the maximum number of workers is reached, an event is emitted. If you want- constructor
- emitter?
- file
Path
-- max
-- next
Message Id
+- max
- number
Of Workers
- opts
-- promise
Map
-- tasks
+- promise
Response Map
- worker
Choice Strategy Context
-- workers
+- worker
Nodes
- busy
-- number
Of Running Tasks
+- full
+- number
Of Queued Tasks
+- number
Of Running Tasks
- type
+- after
Promise Response Hook
- after
Worker Setup
-- choose
Worker
+- before
Promise Response Hook
+- choose
Worker Node
- create
And Setup Worker
- create
Worker
-- decrease
Workers Tasks
- destroy
- destroy
Worker
- execute
-- find
Free Worker
-- get
Worker Index
-- get
Worker Running Tasks
-- increase
Workers Task
-- internal
Execute
-- internal
Get Busy Status
+- find
Free Worker Node Key
+- internal
Busy
- is
Main
- register
Worker Message Listener
-- remove
Worker
- send
To Worker
- set
Worker Choice Strategy
- setup
Hook