X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=db9af90629dcc65a13984858d0b4d8e1618f524c;hp=30969c24eba5305e5ab3a9f7431500638caca2a7;hpb=447eca603b96bc46303dfa16f3048b68ae576b0c;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 30969c24..4f501d6f 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.7.0
+AbstractPool | poolifier - v3.0.4
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:65
Constructors
@@ -203,13 +203,14 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -248,7 +249,7 @@
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -256,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:130
Protected
promise Response Map
@@ -269,7 +270,7 @@
+Defined in src/pools/abstract-pool.ts:88
Private
Readonly
start Timestamp
start Timestamp : number
@@ -277,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:118
Private
started
started : boolean
@@ -285,7 +286,7 @@
+Defined in src/pools/abstract-pool.ts:110
Private
starting
starting : boolean
@@ -293,7 +294,7 @@
+Defined in src/pools/abstract-pool.ts:114
Private
Readonly
task Functions
@@ -305,7 +306,7 @@
+Defined in src/pools/abstract-pool.ts:105
Protected
worker Choice Strategy Context
@@ -313,7 +314,7 @@
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
worker Nodes
@@ -322,7 +323,7 @@
+Defined in src/pools/abstract-pool.ts:71
Protected
full
@@ -348,7 +349,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:659
+Defined in src/pools/abstract-pool.ts:272
Protected
max Size
@@ -371,7 +372,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:485
Protected
min Size
@@ -382,7 +383,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -393,7 +394,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -405,7 +406,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -428,7 +429,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:473
+Defined in src/pools/abstract-pool.ts:1613
Protected
after Task Execution Hook
@@ -508,7 +509,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1041
Protected
after Worker Node Setup
@@ -528,7 +529,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1354
Protected
before Task Execution Hook
@@ -553,7 +554,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1011
Private
build Tasks Queue Options
@@ -566,7 +567,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:598
Private
check And Emit Dynamic Worker Creation Events
@@ -574,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1588
Private
check And Emit Task Execution Events
@@ -582,7 +583,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1576
Private
check And Emit Task Queuing Events
@@ -590,35 +591,7 @@ Can be overridden.
Returns void
-
-Protected
check Dynamic Pool Size
-
-check Dynamic Pool Size ( min , max ) : void
-
-
-
Parameters
-
-
-min : number
-
-max : number
-Returns void
-
-Private
check File Path
-
-check File Path ( filePath ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:1582
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:495
Private
check Number Of Workers
@@ -652,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
check Pool Options
@@ -665,33 +638,7 @@ Can be overridden.
Returns void
-
-Private
check Valid Tasks Queue Options
-
-check Valid Tasks Queue Options ( tasksQueueOptions ) : void
-
-
-Returns void
-
-Private
check Valid Worker Choice Strategy
-
-check Valid Worker Choice Strategy ( workerChoiceStrategy ) : void
-
-
-
Parameters
-
-
-workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-Returns void
+Defined in src/pools/abstract-pool.ts:189
Private
check Valid Worker Choice Strategy Options
@@ -704,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
choose Worker Node
@@ -717,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1168
Protected
create And Setup Dynamic Worker Node
@@ -729,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1258
Protected
create And Setup Worker Node
@@ -741,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1214
Protected
Abstract
create Worker
@@ -753,7 +700,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1207
Private
delete Task Function Worker Usages
@@ -766,7 +713,7 @@ Can be overridden.
name : string
Returns void
+Defined in src/pools/abstract-pool.ts:863
Private
dequeue Task
@@ -779,7 +726,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1682
+
+Protected
Abstract
deregister Worker Message Listener
+
+deregister Worker Message Listener < Message > ( workerNodeKey , listener ) : void
+
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+
+
+listener : ( ( message ) => void )
+
+
+
+
+
+( message ) : void
+
+
+Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:948
Protected
Abstract
destroy Worker Node
@@ -810,7 +797,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:987
+Defined in src/pools/abstract-pool.ts:563
Private
enqueue Task
@@ -850,7 +837,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1676
+Defined in src/pools/abstract-pool.ts:878
Private
execute Task
@@ -905,7 +892,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1670
+
+Protected
flag Worker Node As Not Ready
+
+flag Worker Node As Not Ready ( workerNodeKey ) : void
+
+
+Returns void
Protected
flush Tasks Queue
@@ -918,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1690
Private
flush Tasks Queues
@@ -926,7 +926,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1700
Protected
get Worker Info
@@ -946,7 +946,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1602
Private
get Worker Node Key By Worker
@@ -966,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:511
Private
get Worker Node Key By Worker Id
@@ -986,7 +986,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:523
+
+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
@@ -999,7 +1025,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1548
Private
handle Worker Ready Response
@@ -1012,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1532
Private
has Back Pressure
@@ -1020,7 +1046,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1655
+Defined in src/pools/abstract-pool.ts:791
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1648
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -1074,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:675
Protected
Abstract
is Main
@@ -1085,7 +1119,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1002
+Defined in src/pools/abstract-pool.ts:843
Private
redistribute Queued Tasks
@@ -1111,7 +1145,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1404
+
+Protected
Abstract
register Once Worker Message Listener
+
+register Once Worker Message Listener < Message > ( workerNodeKey , listener ) : void
+
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+
+
+listener : ( ( message ) => void )
+
+
+
+
+
+( message ) : void
+
+
+Returns void
+Returns void
+
Protected
Abstract
register Worker Message Listener
@@ -1151,7 +1225,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1315
+Defined in src/pools/abstract-pool.ts:827
Private
remove Worker Node
@@ -1191,7 +1265,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1635
Protected
send Kill Message To Worker
@@ -1204,7 +1278,7 @@ Can be overridden.
workerNodeKey : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:959
Protected
Abstract
send Startup Message To Worker
@@ -1223,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1385
Private
send Statistics Message To Worker
@@ -1242,7 +1316,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1392
Private
send Task Function Operation To Worker
@@ -1257,7 +1331,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:694
Private
send Task Function Operation To Workers
@@ -1270,7 +1344,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:735
Protected
Abstract
send To Worker
@@ -1299,7 +1373,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
+Defined in src/pools/abstract-pool.ts:856
Private
set Task Stealing
@@ -1328,7 +1402,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:618
+Defined in src/pools/abstract-pool.ts:577
Private
set Tasks Queue Size
@@ -1361,7 +1435,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:612
Private
set Tasks Stealing On Back Pressure
@@ -1369,7 +1443,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:636
+Defined in src/pools/abstract-pool.ts:530
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:549
Protected
setup Hook
@@ -1426,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private
shall Create Dynamic Worker
@@ -1438,7 +1512,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1185
Private
shall Execute Task
@@ -1451,7 +1525,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:869
Private
shall Update Task Function Worker Usage
@@ -1471,7 +1545,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1074
-
-Private
task Stealing On Empty Queue
-
-task Stealing On Empty Queue ( workerId ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:932
Private
tasks Queue Size
@@ -1509,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:1686
Private
unset Task Stealing
@@ -1530,7 +1578,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:627
Private
unset Tasks Stealing On Back Pressure
@@ -1538,7 +1586,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:645
Private
update Elu Worker Usage
@@ -1553,7 +1601,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1128
Private
update Run Time Worker Usage
@@ -1568,7 +1616,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1101
Private
update Task Statistics Worker Usage
@@ -1583,7 +1631,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1083
Private
update Task Stolen Statistics Worker Usage
@@ -1598,7 +1646,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1425
Private
update Wait Time Worker Usage
@@ -1613,34 +1661,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1691,13 +1728,9 @@ Can be overridden.
check And Emit Dynamic Worker Creation Events
check And Emit Task Execution Events
check And Emit Task Queuing Events
-check Dynamic Pool Size
-check File Path
check Message Worker Id
check Number Of Workers
check Pool Options
-check Valid Tasks Queue Options
-check Valid Worker Choice Strategy
check Valid Worker Choice Strategy Options
choose Worker Node
create And Setup Dynamic Worker Node
@@ -1705,26 +1738,32 @@ Can be overridden.
create Worker
delete Task Function Worker Usages
dequeue Task
+deregister Worker Message Listener
destroy
destroy Worker Node
enable Tasks Queue
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
redistribute Queued Tasks
+register Once Worker Message Listener
register Worker Message Listener
remove Task Function
remove Worker Node
@@ -1746,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
@@ -1756,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