X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=f9dfcb3931ff6e9456eb709d474b12fb2b9b622d;hb=b2ec8632edaea1f4ee24a532e61ca6e5619b7bfb;hp=92d33f8c78905248290b9bb99ce81ef9e485c8d2;hpb=d93988cdbc3eb55747301602bfa03d8543223c71;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 92d33f8c..f9dfcb39 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.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:
@@ -173,7 +174,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:75
Path
file Path: string
@@ -182,7 +183,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:130
max?: number
@@ -191,7 +192,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:80
Of Workers
number Of Workers: number
@@ -200,7 +201,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:129
opts: ClusterPoolOptions = {}
@@ -209,7 +210,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/fixed.ts:47
Response Map
promise Response Map: Map<string, PromiseResponseWrapper<Response>> = ...
@@ -223,7 +224,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>
@@ -232,7 +233,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:95
Nodes
worker Nodes: IWorkerNode<Worker, Data>[] = []
@@ -241,7 +242,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:72
@@ -256,7 +257,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/fixed.ts:140
+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/fixed.ts:130
+Defined in src/pools/abstract-pool.ts:448
+Defined in src/pools/cluster/fixed.ts:135
@@ -388,7 +389,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
Optional
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@@ -269,7 +270,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
info
@@ -281,7 +282,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
max@@ -293,7 +294,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
min@@ -305,7 +306,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
ready@@ -317,7 +318,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
type@@ -330,7 +331,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
utilization@@ -343,7 +344,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
worker@@ -355,7 +356,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Methods
Protected
after@@ -414,7 +415,7 @@ Can be overridden.
Protected
after@@ -435,7 +436,7 @@ Can be overridden.
Protected
before@@ -461,7 +462,7 @@ Can be overridden.
Protected
create@@ -474,7 +475,7 @@ Can be overridden.
Protected
create@@ -487,7 +488,7 @@ Can be overridden.
Protected
create@@ -500,7 +501,7 @@ Can be overridden.
Protected
deregister@@ -541,7 +542,7 @@ Can be overridden.
destroy
@@ -553,7 +554,7 @@ Can be overridden.
Protected
destroy@@ -573,7 +574,7 @@ Can be overridden.
enable Tasks Queue
@@ -598,7 +599,7 @@ Can be overridden.
execute
@@ -629,7 +630,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@@ -643,7 +658,7 @@ Can be overridden.
Returns void
Protected
get@@ -664,7 +679,7 @@ Can be overridden.
has Task Function
@@ -685,7 +700,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -706,7 +721,7 @@ Can be overridden.
Protected
internal@@ -719,7 +734,7 @@ Can be overridden.
Protected
is@@ -731,7 +746,7 @@ Can be overridden.
list Task Function Names
@@ -744,7 +759,7 @@ Can be overridden.
Protected
register@@ -785,7 +800,7 @@ Can be overridden.
Protected
register@@ -826,7 +841,7 @@ Can be overridden.
remove Task Function
@@ -847,7 +862,7 @@ Can be overridden.
Protected
send@@ -861,7 +876,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -881,7 +896,7 @@ Can be overridden.
Protected
send@@ -906,7 +921,7 @@ Can be overridden.
set Default Task Function
@@ -927,7 +942,7 @@ Can be overridden.
set Tasks Queue Options
@@ -947,7 +962,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -972,7 +987,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -992,7 +1007,7 @@ Can be overridden.
Protected
setup@@ -1005,7 +1020,7 @@ Can be overridden.
start
@@ -1017,35 +1032,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