X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=b656440d69d06f603b8bc4c23ca4dfe489cbef74;hp=19f0f6a13a78d24ad8f9607e7fbf63e6d8b1720d;hpb=da66e34cda2cbcb3a94865d24696c668f50a1437;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 19f0f6a1..57b75a1a 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.45
+AbstractPool | poolifier - v3.0.0
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:64
@@ -87,7 +88,8 @@
Constructors
@@ -195,13 +202,14 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -240,7 +248,7 @@
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -248,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:129
Protected
promise Response Map
@@ -261,7 +269,7 @@
+Defined in src/pools/abstract-pool.ts:87
Private
Readonly
start Timestamp
start Timestamp : number
@@ -269,7 +277,7 @@
+Defined in src/pools/abstract-pool.ts:117
Private
started
started : boolean
@@ -277,7 +285,7 @@
+Defined in src/pools/abstract-pool.ts:109
Private
starting
starting : boolean
@@ -285,7 +293,19 @@
+Defined in src/pools/abstract-pool.ts:113
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -293,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:93
Readonly
Internal
worker Nodes
@@ -302,7 +322,7 @@
+Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -328,7 +348,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:651
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -351,7 +371,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -362,7 +382,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -373,7 +393,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:429
Protected
Abstract
type
@@ -385,7 +405,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:467
+Defined in src/pools/abstract-pool.ts:446
Protected
Abstract
worker
@@ -408,9 +428,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:472
Protected
after Task Execution Hook
@@ -457,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1033
Protected
after Worker Node Setup
@@ -477,7 +528,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1344
Protected
before Task Execution Hook
@@ -502,7 +553,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1003
Private
build Tasks Queue Options
@@ -515,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:600
Private
check And Emit Dynamic Worker Creation Events
@@ -523,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1568
Private
check And Emit Task Execution Events
@@ -531,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1556
Private
check And Emit Task Queuing Events
@@ -539,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:1562
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:494
Private
check Number Of Workers
@@ -601,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
check Pool Options
@@ -614,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:188
Private
check Valid Worker Choice Strategy Options
@@ -653,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
choose Worker Node
@@ -666,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1160
Protected
create And Setup Dynamic Worker Node
@@ -678,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1250
Protected
create And Setup Worker Node
@@ -690,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1206
Protected
Abstract
create Worker
@@ -702,7 +699,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1199
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -715,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1658
+
+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:940
Protected
Abstract
destroy Worker Node
@@ -746,7 +796,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:979
+Defined in src/pools/abstract-pool.ts:565
Private
enqueue Task
@@ -786,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1652
+Defined in src/pools/abstract-pool.ts:870
Private
execute Task
@@ -841,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1646
Protected
flush Tasks Queue
@@ -854,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1666
Private
flush Tasks Queues
@@ -862,7 +912,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1676
Protected
get Worker Info
@@ -882,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1582
Private
get Worker Node Key By Worker
@@ -902,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:513
Private
get Worker Node Key By Worker Id
@@ -914,7 +964,7 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | number
@@ -922,7 +972,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:525
Private
handle Task Execution Response
@@ -935,7 +985,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1528
Private
handle Worker Ready Response
@@ -948,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1512
Private
has Back Pressure
@@ -956,7 +1006,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1631
+
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1624
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -989,7 +1068,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
Abstract
is Main
@@ -1000,20 +1079,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:835
Private
redistribute Queued Tasks
@@ -1026,7 +1105,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1390
+
+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
@@ -1066,7 +1185,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1305
+
Private
remove Worker Node
@@ -1085,22 +1225,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1615
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:951
Protected
Abstract
send Startup Message To Worker
@@ -1119,7 +1257,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1371
Private
send Statistics Message To Worker
@@ -1138,7 +1276,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1378
+
+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
@@ -1167,7 +1333,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1188
+
+set Default Task Function
+
Private
set Task Stealing
@@ -1175,7 +1362,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:620
+Defined in src/pools/abstract-pool.ts:579
Private
set Tasks Queue Size
@@ -1208,7 +1395,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:614
Private
set Tasks Stealing On Back Pressure
@@ -1216,7 +1403,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:633
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1273,7 +1460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:987
Private
shall Create Dynamic Worker
@@ -1285,7 +1472,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1177
Private
shall Execute Task
@@ -1298,7 +1485,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:861
Private
shall Update Task Function Worker Usage
@@ -1318,7 +1505,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1066
+Defined in src/pools/abstract-pool.ts:924
Private
task Stealing On Empty Queue
@@ -1343,7 +1530,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1430
Private
tasks Queue Size
@@ -1356,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1662
Private
tasks Stealing On Back Pressure
@@ -1369,7 +1556,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1458
Private
unset Task Stealing
@@ -1377,7 +1564,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:627
Private
unset Tasks Stealing On Back Pressure
@@ -1385,7 +1572,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:640
Private
update Elu Worker Usage
@@ -1400,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1120
Private
update Run Time Worker Usage
@@ -1415,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1093
Private
update Task Statistics Worker Usage
@@ -1430,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1075
Private
update Task Stolen Statistics Worker Usage
@@ -1445,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1411
Private
update Wait Time Worker Usage
@@ -1460,34 +1647,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1517,6 +1693,7 @@ Can be overridden.
start Timestamp
started
starting
+task Functions
worker Choice Strategy Context
worker Nodes
busy
@@ -1528,6 +1705,7 @@ Can be overridden.
type
utilization
worker
+add Task Function
add Worker Node
after Task Execution Hook
after Worker Node Setup
@@ -1536,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
@@ -1563,17 +1739,24 @@ Can be overridden.
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
@@ -1595,9 +1778,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