X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=ae97fc9c47f17ba9f1c4a5f03a3d8e2956420eaf;hb=b2ec8632edaea1f4ee24a532e61ca6e5619b7bfb;hp=3c8b321fcf74e144f7d792f234d8c661977ec7ba;hpb=25926072f5397949802f6af5a2f7d49d6f15cacc;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 3c8b321f..ae97fc9c 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Optional
emitterGenerated using TypeDoc
Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
@@ -178,7 +179,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:75
Path
file Path: string
@@ -187,7 +188,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:130
max: number
@@ -196,7 +197,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/dynamic.ts:30
Of Workers
number Of Workers: number
@@ -205,7 +206,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:129
opts: ClusterPoolOptions = {}
@@ -214,7 +215,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/fixed.ts:47
Response Map
promise Response Map: Map<string, PromiseResponseWrapper<Response>> = ...
@@ -228,7 +229,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:89
Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext<Worker, Data, Response>
@@ -237,7 +238,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:95
Nodes
worker Nodes: IWorkerNode<Worker, Data>[] = []
@@ -246,7 +247,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:72
@@ -261,7 +262,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/dynamic.ts:44
+Defined in src/pools/abstract-pool.ts:660
+Defined in src/pools/abstract-pool.ts:273
Size
+Defined in src/pools/abstract-pool.ts:486
Size
+Defined in src/pools/abstract-pool.ts:479
+Defined in src/pools/abstract-pool.ts:431
+Defined in src/pools/cluster/dynamic.ts:39
+Defined in src/pools/abstract-pool.ts:448
+Defined in src/pools/cluster/fixed.ts:135
@@ -393,7 +394,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:805
Task Execution Hook
+Defined in src/pools/abstract-pool.ts:1043
Worker Node Setup
+Defined in src/pools/abstract-pool.ts:1356
Task Execution Hook
+Defined in src/pools/abstract-pool.ts:1013
And Setup Dynamic Worker Node
+Defined in src/pools/abstract-pool.ts:1260
And Setup Worker Node
+Defined in src/pools/abstract-pool.ts:1216
Worker
+Defined in src/pools/cluster/fixed.ts:125
Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:117
+Defined in src/pools/abstract-pool.ts:949
Worker Node
+Defined in src/pools/cluster/fixed.ts:63
+Defined in src/pools/abstract-pool.ts:564
+Defined in src/pools/abstract-pool.ts:879
+
+
Tasks Queue
+Defined in src/pools/abstract-pool.ts:1696
Worker Info
+Defined in src/pools/abstract-pool.ts:1608
+Defined in src/pools/abstract-pool.ts:792
+Defined in src/pools/abstract-pool.ts:1654
Busy
+Defined in src/pools/abstract-pool.ts:676
Main
+Defined in src/pools/cluster/fixed.ts:58
+Defined in src/pools/abstract-pool.ts:844
Once Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:109
Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:101
+Defined in src/pools/abstract-pool.ts:828
Kill Message To Worker
+Defined in src/pools/abstract-pool.ts:960
Startup Message To Worker
+Defined in src/pools/cluster/fixed.ts:94
To Worker
+Defined in src/pools/cluster/fixed.ts:83
+Defined in src/pools/abstract-pool.ts:857
+Defined in src/pools/abstract-pool.ts:578
+Defined in src/pools/abstract-pool.ts:531
+Defined in src/pools/abstract-pool.ts:550
Hook
+Defined in src/pools/cluster/fixed.ts:53
-
-Defined in src/pools/abstract-pool.ts:933
+
+ Message Listener
Protected
Readonly
filepoolifier:<PoolType>-<Wo
Protected
Readonly
maxpoolifier:<PoolType>-<Wo
Protected
Readonly
numberpoolifier:<PoolType>-<Wo
Protected
Readonly
optspoolifier:<PoolType>-<Wo
Protected
promisepoolifier:<PoolType>-<Wo
Protected
workerpoolifier:<PoolType>-<Wo
Readonly
Internal
workerpoolifier:<PoolType>-<Wo
Accessors
poolifier:<PoolType>-<Wo
Protected
full@@ -274,7 +275,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
info
@@ -286,7 +287,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
max@@ -298,7 +299,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
min@@ -310,7 +311,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
ready@@ -322,7 +323,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
type@@ -335,7 +336,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
utilization@@ -348,7 +349,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
worker@@ -360,7 +361,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Methods
Protected
after@@ -419,7 +420,7 @@ Can be overridden.
Protected
after@@ -440,7 +441,7 @@ Can be overridden.
Protected
before@@ -466,7 +467,7 @@ Can be overridden.
Protected
create@@ -479,7 +480,7 @@ Can be overridden.
Protected
create@@ -492,7 +493,7 @@ Can be overridden.
Protected
create@@ -505,7 +506,7 @@ Can be overridden.
Protected
deregister@@ -546,7 +547,7 @@ Can be overridden.
destroy
@@ -558,7 +559,7 @@ Can be overridden.
Protected
destroy@@ -578,7 +579,7 @@ Can be overridden.
enable Tasks Queue
@@ -603,7 +604,7 @@ Can be overridden.
execute
@@ -634,7 +635,21 @@ Can be overridden.
Worker Node As Not Ready
+Protected
flag+- flag
Worker Node As Not Ready(workerNodeKey): void
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
Protected
flush@@ -648,7 +663,7 @@ Can be overridden.
Returns void
Protected
get@@ -669,7 +684,7 @@ Can be overridden.
has Task Function
@@ -690,7 +705,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -711,7 +726,7 @@ Can be overridden.
Protected
internal@@ -724,7 +739,7 @@ Can be overridden.
Protected
is@@ -736,7 +751,7 @@ Can be overridden.
list Task Function Names
@@ -749,7 +764,7 @@ Can be overridden.
Protected
register@@ -790,7 +805,7 @@ Can be overridden.
Protected
register@@ -831,7 +846,7 @@ Can be overridden.
remove Task Function
@@ -852,7 +867,7 @@ Can be overridden.
Protected
send@@ -866,7 +881,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -886,7 +901,7 @@ Can be overridden.
Protected
send@@ -911,7 +926,7 @@ Can be overridden.
set Default Task Function
@@ -932,7 +947,7 @@ Can be overridden.
set Tasks Queue Options
@@ -952,7 +967,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -977,7 +992,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -997,7 +1012,7 @@ Can be overridden.
Protected
setup@@ -1010,7 +1025,7 @@ Can be overridden.
start
@@ -1022,35 +1037,24 @@ Can be overridden.
Listener
+Protected
workerProtected
worker-- worker
Listener(): ((message) => void)
+- worker
Message Listener(message): void
-
-
-
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.
- ---
-
-- (message): void
--
-
-
-
+ - Defined in src/pools/abstract-pool.ts:1518
This method is the listener registered for each worker message.
+This method is the message listener registered on each worker.
Parameters
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
- - +Returns void