X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=60e3c607794b436d8df80a4558cc8b5d41771dd4;hb=1b27b0580ef80da95449c262682015a6da19e226;hp=57019215eab51531af8a99c7d0f472ca09bc6c9b;hpb=25926072f5397949802f6af5a2f7d49d6f15cacc;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 57019215..60e3c607 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.7.4
+AbstractPool | poolifier - v3.0.5
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:66
Constructors
@@ -202,12 +203,12 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:128
Properties
Optional
emitter
-emitter ?: __module | EventEmitterAsyncResource
+emitter ?: EventEmitterAsyncResource
+Defined in src/pools/abstract-pool.ts:130
Protected
Optional
Readonly
max
max ?: number
@@ -240,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:80
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -248,7 +249,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:129
Protected
Readonly
opts
@@ -256,7 +257,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:131
Protected
promise Response Map
@@ -269,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:89
Private
Readonly
start Timestamp
start Timestamp : number
@@ -277,7 +278,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:119
Private
started
started : boolean
@@ -285,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:111
Private
starting
starting : boolean
@@ -293,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:115
Private
Readonly
task Functions
@@ -305,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:106
Protected
worker Choice Strategy Context
@@ -313,7 +314,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:95
Readonly
Internal
worker Nodes
@@ -322,7 +323,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:72
Accessors
@@ -336,7 +337,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:669
Protected
full
@@ -348,7 +349,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:660
info
@@ -360,7 +361,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:273
Protected
max Size
@@ -371,7 +372,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:486
Protected
min Size
@@ -382,7 +383,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:479
Private
ready
@@ -393,7 +394,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:431
Protected
Abstract
type
@@ -405,7 +406,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:469
Private
utilization
@@ -417,7 +418,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:448
Protected
Abstract
worker
@@ -428,7 +429,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:474
+Defined in src/pools/abstract-pool.ts:1619
Protected
after Task Execution Hook
@@ -508,7 +509,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1043
Protected
after Worker Node Setup
@@ -528,7 +529,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1356
Protected
before Task Execution Hook
@@ -553,7 +554,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1013
Private
build Tasks Queue Options
@@ -566,7 +567,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:599
Private
check And Emit Dynamic Worker Creation Events
@@ -574,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1594
Private
check And Emit Task Execution Events
@@ -582,7 +583,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1582
Private
check And Emit Task Queuing Events
@@ -590,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
@@ -624,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:172
Private
check Pool Options
@@ -637,7 +638,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:190
Private
check Valid Worker Choice Strategy Options
@@ -650,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:219
Private
choose Worker Node
@@ -663,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1170
Protected
create And Setup Dynamic Worker Node
@@ -675,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1260
Protected
create And Setup Worker Node
@@ -687,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1216
Protected
Abstract
create Worker
@@ -699,7 +700,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1209
Private
delete Task Function Worker Usages
@@ -712,7 +713,7 @@ Can be overridden.
name : string
Returns void
+Defined in src/pools/abstract-pool.ts:864
Private
dequeue Task
@@ -725,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
@@ -765,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
@@ -796,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
@@ -836,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
@@ -891,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
@@ -904,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1696
Private
flush Tasks Queues
@@ -912,7 +926,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1706
Protected
get Worker Info
@@ -932,7 +946,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1608
Private
get Worker Node Key By Worker
@@ -952,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:512
Private
get Worker Node Key By Worker Id
@@ -972,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
@@ -985,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
@@ -998,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1534
Private
has Back Pressure
@@ -1006,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
@@ -1056,7 +1096,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:266
Protected
internal Busy
@@ -1068,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:676
Protected
Abstract
is Main
@@ -1079,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
@@ -1105,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
@@ -1145,7 +1185,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1330
Protected
Abstract
register Worker Message Listener
@@ -1185,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
@@ -1225,7 +1265,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1641
Protected
send Kill Message To Worker
@@ -1238,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
@@ -1257,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1387
Private
send Statistics Message To Worker
@@ -1276,7 +1316,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1394
Private
send Task Function Operation To Worker
@@ -1291,7 +1331,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:695
Private
send Task Function Operation To Workers
@@ -1304,7 +1344,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:736
Protected
Abstract
send To Worker
@@ -1333,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
@@ -1362,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
@@ -1395,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
@@ -1403,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
@@ -1460,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:997
Private
shall Create Dynamic Worker
@@ -1472,7 +1512,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1187
Private
shall Execute Task
@@ -1485,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
@@ -1505,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
@@ -1543,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
@@ -1564,7 +1578,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:628
Private
unset Tasks Stealing On Back Pressure
@@ -1572,7 +1586,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:646
Private
update Elu Worker Usage
@@ -1587,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
@@ -1602,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
@@ -1617,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
@@ -1632,7 +1646,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1427
Private
update Wait Time Worker Usage
@@ -1647,34 +1661,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1742,11 +1745,14 @@ 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
@@ -1779,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
@@ -1789,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
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:
@@ -224,7 +225,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:75
Path
file Path: string
@@ -232,7 +233,7 @@ The async tracking tooling identifier is
Protected
Readonly
filepoolifier:<PoolType>-<Wo