X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=60e3c607794b436d8df80a4558cc8b5d41771dd4;hb=1b27b0580ef80da95449c262682015a6da19e226;hp=2ce0d07325a0a5f99ba1c8f1ba85367e44201b45;hpb=c11be5eddc7229e4b77105ed27e93697b65d0146;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2ce0d073..60e3c607 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.7.2
+AbstractPool | poolifier - v3.0.5
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:66
Constructors
@@ -201,13 +203,14 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -246,7 +249,7 @@
+Defined in src/pools/abstract-pool.ts:129
Protected
Readonly
opts
@@ -254,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:131
Protected
promise Response Map
@@ -267,7 +270,7 @@
+Defined in src/pools/abstract-pool.ts:89
Private
Readonly
start Timestamp
start Timestamp : number
@@ -275,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:119
Private
started
started : boolean
@@ -283,7 +286,7 @@
+Defined in src/pools/abstract-pool.ts:111
Private
starting
starting : boolean
@@ -291,7 +294,7 @@
+Defined in src/pools/abstract-pool.ts:115
Private
Readonly
task Functions
@@ -303,7 +306,7 @@
+Defined in src/pools/abstract-pool.ts:106
Protected
worker Choice Strategy Context
@@ -311,7 +314,7 @@
+Defined in src/pools/abstract-pool.ts:95
Readonly
Internal
worker Nodes
@@ -320,7 +323,7 @@
+Defined in src/pools/abstract-pool.ts:72
Protected
full
@@ -346,7 +349,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:660
+Defined in src/pools/abstract-pool.ts:273
Protected
max Size
@@ -369,7 +372,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:486
Protected
min Size
@@ -380,7 +383,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:479
Private
ready
@@ -391,7 +394,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:431
Protected
Abstract
type
@@ -403,7 +406,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:469
+Defined in src/pools/abstract-pool.ts:448
Protected
Abstract
worker
@@ -426,7 +429,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:474
+Defined in src/pools/abstract-pool.ts:1619
Protected
after Task Execution Hook
@@ -506,7 +509,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1043
Protected
after Worker Node Setup
@@ -526,7 +529,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1356
Protected
before Task Execution Hook
@@ -551,7 +554,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1013
Private
build Tasks Queue Options
@@ -564,7 +567,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:599
Private
check And Emit Dynamic Worker Creation Events
@@ -572,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1594
Private
check And Emit Task Execution Events
@@ -580,7 +583,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1582
Private
check And Emit Task Queuing Events
@@ -588,7 +591,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1588
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:496
Private
check Number Of Workers
@@ -622,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:172
Private
check Pool Options
@@ -635,7 +638,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:190
Private
check Valid Worker Choice Strategy Options
@@ -648,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:219
Private
choose Worker Node
@@ -661,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1170
Protected
create And Setup Dynamic Worker Node
@@ -673,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1260
Protected
create And Setup Worker Node
@@ -685,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1216
Protected
Abstract
create Worker
@@ -697,7 +700,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1209
Private
delete Task Function Worker Usages
@@ -710,7 +713,7 @@ Can be overridden.
name : string
Returns void
+Defined in src/pools/abstract-pool.ts:864
Private
dequeue Task
@@ -723,7 +726,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1688
Protected
Abstract
deregister Worker Message Listener
@@ -763,7 +766,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1343
+Defined in src/pools/abstract-pool.ts:949
Protected
Abstract
destroy Worker Node
@@ -794,7 +797,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:989
+Defined in src/pools/abstract-pool.ts:564
Private
enqueue Task
@@ -834,7 +837,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1682
+Defined in src/pools/abstract-pool.ts:879
Private
execute Task
@@ -889,7 +892,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1676
+
+Protected
flag Worker Node As Not Ready
+
+flag Worker Node As Not Ready ( workerNodeKey ) : void
+
+
+Returns void
Protected
flush Tasks Queue
@@ -902,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1696
Private
flush Tasks Queues
@@ -910,7 +926,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1706
Protected
get Worker Info
@@ -930,7 +946,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1608
Private
get Worker Node Key By Worker
@@ -950,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:512
Private
get Worker Node Key By Worker Id
@@ -970,7 +986,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:524
+
+Private
Readonly
handle Back Pressure Event
+
+handle Back Pressure Event ( event ) : void
+
+
+Returns void
+
+Private
Readonly
handle Empty Queue Event
+
+handle Empty Queue Event ( event ) : void
+
+
+Returns void
Private
handle Task Execution Response
@@ -983,7 +1025,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1554
Private
handle Worker Ready Response
@@ -996,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1534
Private
has Back Pressure
@@ -1004,7 +1046,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1661
+Defined in src/pools/abstract-pool.ts:792
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1654
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -1058,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:676
Protected
Abstract
is Main
@@ -1069,7 +1119,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1004
+Defined in src/pools/abstract-pool.ts:844
Private
redistribute Queued Tasks
@@ -1095,7 +1145,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1406
Protected
Abstract
register Once Worker Message Listener
@@ -1135,7 +1185,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1330
Protected
Abstract
register Worker Message Listener
@@ -1175,7 +1225,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1317
+Defined in src/pools/abstract-pool.ts:828
Private
remove Worker Node
@@ -1215,7 +1265,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1641
Protected
send Kill Message To Worker
@@ -1228,7 +1278,7 @@ Can be overridden.
workerNodeKey : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:960
Protected
Abstract
send Startup Message To Worker
@@ -1247,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1387
Private
send Statistics Message To Worker
@@ -1266,7 +1316,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1394
Private
send Task Function Operation To Worker
@@ -1281,7 +1331,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:695
Private
send Task Function Operation To Workers
@@ -1294,7 +1344,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:736
Protected
Abstract
send To Worker
@@ -1323,7 +1373,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1198
+Defined in src/pools/abstract-pool.ts:857
Private
set Task Stealing
@@ -1352,7 +1402,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:619
+Defined in src/pools/abstract-pool.ts:578
Private
set Tasks Queue Size
@@ -1385,7 +1435,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:613
Private
set Tasks Stealing On Back Pressure
@@ -1393,7 +1443,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:637
+Defined in src/pools/abstract-pool.ts:531
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:550
Protected
setup Hook
@@ -1450,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:997
Private
shall Create Dynamic Worker
@@ -1462,7 +1512,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1187
Private
shall Execute Task
@@ -1475,7 +1525,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:870
Private
shall Update Task Function Worker Usage
@@ -1495,7 +1545,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1076
-
-Private
task Stealing On Empty Queue
-
-task Stealing On Empty Queue ( workerId ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:933
Private
tasks Queue Size
@@ -1533,20 +1570,7 @@ Can be overridden.
workerNodeKey : number
Returns number
-
-Private
tasks Stealing On Back Pressure
-
-tasks Stealing On Back Pressure ( workerId ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:1692
Private
unset Task Stealing
@@ -1554,7 +1578,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:628
Private
unset Tasks Stealing On Back Pressure
@@ -1562,7 +1586,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:646
Private
update Elu Worker Usage
@@ -1577,7 +1601,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1130
Private
update Run Time Worker Usage
@@ -1592,7 +1616,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1103
Private
update Task Statistics Worker Usage
@@ -1607,7 +1631,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1085
Private
update Task Stolen Statistics Worker Usage
@@ -1622,7 +1646,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1427
Private
update Wait Time Worker Usage
@@ -1637,34 +1661,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1732,16 +1745,20 @@ Can be overridden.
enqueue Task
execute
execute Task
+flag Worker Node As Not Ready
flush Tasks Queue
flush Tasks Queues
get Worker Info
get Worker Node Key By Worker
get Worker Node Key By Worker Id
+handle Back Pressure Event
+handle Empty Queue Event
handle Task Execution Response
handle Worker Ready Response
has Back Pressure
has Task Function
has Worker Node Back Pressure
+initialize Event Emitter
internal Busy
is Main
list Task Function Names
@@ -1768,9 +1785,7 @@ Can be overridden.
shall Execute Task
shall Update Task Function Worker Usage
start
-task Stealing On Empty Queue
tasks Queue Size
-tasks Stealing On Back Pressure
unset Task Stealing
unset Tasks Stealing On Back Pressure
update Elu Worker Usage
@@ -1778,9 +1793,9 @@ Can be overridden.
update Task Statistics Worker Usage
update Task Stolen Statistics Worker Usage
update Wait Time Worker Usage
-worker Listener
+worker Message Listener
-
\ No newline at end of file
+
\ No newline at end of file
Emitter on which events can be listened to.
+
+Optional
emitterEvent 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:
'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.Protected
Readonly
fileProtected
Optional
Readonly
max