X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=ed6afb83fa7e1265ba656aaaefb1de57dd51fa5a;hp=86fada26adb28db38824ca5ecf87c2b5d236b18c;hpb=0b4e655ca22daa4e6efc10d4ef575520a3abfa2c;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 86fada26..072c9da0 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.45
+AbstractPool | poolifier - v3.0.1
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:65
@@ -87,7 +88,8 @@
Constructors
@@ -191,13 +202,14 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -236,7 +248,7 @@
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -244,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:130
Protected
promise Response Map
@@ -257,7 +269,7 @@
+Defined in src/pools/abstract-pool.ts:88
Private
Readonly
start Timestamp
start Timestamp : number
@@ -265,7 +277,7 @@
+Defined in src/pools/abstract-pool.ts:118
Private
started
started : boolean
@@ -273,7 +285,7 @@
+Defined in src/pools/abstract-pool.ts:110
Private
starting
starting : boolean
@@ -281,7 +293,19 @@
+Defined in src/pools/abstract-pool.ts:114
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -289,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
worker Nodes
@@ -298,7 +322,7 @@
+Defined in src/pools/abstract-pool.ts:71
Protected
full
@@ -324,7 +348,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:662
+Defined in src/pools/abstract-pool.ts:272
Protected
max Size
@@ -347,7 +371,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:485
Protected
min Size
@@ -358,7 +382,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -369,7 +393,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -381,7 +405,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -404,9 +428,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:473
Protected
after Task Execution Hook
@@ -453,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1044
Protected
after Worker Node Setup
@@ -473,7 +528,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1355
Protected
before Task Execution Hook
@@ -498,7 +553,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1014
Private
build Tasks Queue Options
@@ -511,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:601
Private
check And Emit Dynamic Worker Creation Events
@@ -519,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1589
Private
check And Emit Task Execution Events
@@ -527,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1577
Private
check And Emit Task Queuing Events
@@ -535,35 +590,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:1583
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:495
Private
check Number Of Workers
@@ -597,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
check Pool Options
@@ -610,33 +637,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
@@ -649,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
choose Worker Node
@@ -662,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1171
Protected
create And Setup Dynamic Worker Node
@@ -674,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1261
Protected
create And Setup Worker Node
@@ -686,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1217
Protected
Abstract
create Worker
@@ -698,7 +699,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1210
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -711,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1679
+
+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:951
Protected
Abstract
destroy Worker Node
@@ -742,7 +796,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:990
+Defined in src/pools/abstract-pool.ts:566
Private
enqueue Task
@@ -782,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1673
+Defined in src/pools/abstract-pool.ts:881
Private
execute Task
@@ -837,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
flush Tasks Queue
@@ -850,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1687
Private
flush Tasks Queues
@@ -858,7 +912,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1697
Protected
get Worker Info
@@ -878,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1603
Private
get Worker Node Key By Worker
@@ -898,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:514
Private
get Worker Node Key By Worker Id
@@ -910,7 +964,7 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | number
@@ -918,7 +972,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:526
+
+Private
Readonly
handle Back Pressure Event
+
+handle Back Pressure Event ( event ) : void
+
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail >
+Returns void
+
+Private
Readonly
handle Empty Queue Event
+
+handle Empty Queue Event ( event ) : void
+
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail >
+Returns void
Private
handle Task Execution Response
@@ -931,7 +1011,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1549
Private
handle Worker Ready Response
@@ -944,7 +1024,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1533
Private
has Back Pressure
@@ -952,7 +1032,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1652
+
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1645
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -985,7 +1094,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:678
Protected
Abstract
is Main
@@ -996,20 +1105,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:846
Private
redistribute Queued Tasks
@@ -1022,7 +1131,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1405
+
+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
@@ -1062,7 +1211,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1316
+
Private
remove Worker Node
@@ -1081,22 +1251,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1636
Protected
send Kill Message To Worker
-send Kill Message To Worker ( workerNodeKey , workerId ) : Promise < void >
+send Kill Message To Worker ( workerNodeKey ) : Promise < void >
Parameters
-workerNodeKey : number
-
-workerId : number
+workerNodeKey : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:962
Protected
Abstract
send Startup Message To Worker
@@ -1115,7 +1283,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1386
Private
send Statistics Message To Worker
@@ -1134,7 +1302,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1393
+
+Private
send Task Function Operation To Worker
+
+send Task Function Operation To Worker ( workerNodeKey , message ) : Promise < boolean >
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+
+Returns Promise < boolean >
+
+Private
send Task Function Operation To Workers
+
+send Task Function Operation To Workers ( message ) : Promise < boolean >
+
+
+Returns Promise < boolean >
Protected
Abstract
send To Worker
@@ -1163,7 +1359,36 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1199
+
+set Default Task Function
+
+
+Private
set Task Stealing
+
+set Task Stealing ( ) : void
+
+Returns void
+Defined in src/pools/abstract-pool.ts:580
Private
set Tasks Queue Size
@@ -1196,7 +1421,15 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:615
+
+Private
set Tasks Stealing On Back Pressure
+
+set Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
+Defined in src/pools/abstract-pool.ts:533
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:552
Protected
setup Hook
@@ -1253,7 +1486,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:998
Private
shall Create Dynamic Worker
@@ -1265,7 +1498,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1188
Private
shall Execute Task
@@ -1278,7 +1511,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:872
Private
shall Update Task Function Worker Usage
@@ -1298,7 +1531,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1077
-
-Private
task Stealing On Empty Queue
-
-task Stealing On Empty Queue ( workerId ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:935
Private
tasks Queue Size
@@ -1336,20 +1556,23 @@ Can be overridden.
workerNodeKey : number
Returns number
-
+
+Private
unset Task Stealing
-tasks Stealing On Back Pressure ( workerId ) : void
+unset Task Stealing ( ) : void
+
+Returns void
+
+Private
unset Tasks Stealing On Back Pressure
+
+unset Tasks Stealing On Back Pressure ( ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:648
Private
update Elu Worker Usage
@@ -1364,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
update Run Time Worker Usage
@@ -1379,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1104
Private
update Task Statistics Worker Usage
@@ -1394,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1086
Private
update Task Stolen Statistics Worker Usage
@@ -1409,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1426
Private
update Wait Time Worker Usage
@@ -1424,34 +1647,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1481,6 +1693,7 @@ Can be overridden.
start Timestamp
started
starting
+task Functions
worker Choice Strategy Context
worker Nodes
busy
@@ -1492,6 +1705,7 @@ Can be overridden.
type
utilization
worker
+add Task Function
add Worker Node
after Task Execution Hook
after Worker Node Setup
@@ -1500,19 +1714,17 @@ 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
create And Setup Worker Node
create Worker
+delete Task Function Worker Usages
dequeue Task
+deregister Worker Message Listener
destroy
destroy Worker Node
enable Tasks Queue
@@ -1524,22 +1736,33 @@ Can be overridden.
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 Functions
+list Task Function Names
redistribute Queued Tasks
+register Once Worker Message Listener
register Worker Message Listener
+remove Task Function
remove Worker Node
send Kill Message To Worker
send Startup Message To Worker
send Statistics Message To Worker
+send Task Function Operation To Worker
+send Task Function Operation To Workers
send To Worker
+set Default Task Function
+set Task Stealing
set Tasks Queue Options
set Tasks Queue Size
+set Tasks Stealing On Back Pressure
set Worker Choice Strategy
set Worker Choice Strategy Options
setup Hook
@@ -1547,17 +1770,17 @@ 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
update Run Time Worker Usage
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