X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=b5f1d0268446c60c01e1adac42e4c6cc2ec0f38f;hp=0ca50a44ae79957f264f28d6677463e9ffcc45fe;hpb=cb4889b43e6935f6dd70d8011ba085c9ca7218ba;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 0ca50a44..57b75a1a 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.41
+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
@@ -191,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
@@ -236,7 +248,7 @@
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -244,11 +256,11 @@
+Defined in src/pools/abstract-pool.ts:129
Protected
promise Response Map
-
+Defined in src/pools/abstract-pool.ts:117
Private
started
started : boolean
@@ -273,15 +285,27 @@
+Defined in src/pools/abstract-pool.ts:109
-Private
Readonly
starting
+Private
starting
starting : boolean
+Defined in src/pools/abstract-pool.ts:113
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -289,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:93
Readonly
Internal
worker Nodes
@@ -298,7 +322,7 @@
+Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -324,7 +348,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:651
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -347,7 +371,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -358,7 +382,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -369,7 +393,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:429
Protected
Abstract
type
@@ -381,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
@@ -404,9 +428,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:472
Protected
after Task Execution Hook
@@ -453,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1033
Protected
after Worker Node Setup
@@ -473,7 +528,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1344
Protected
before Task Execution Hook
@@ -498,7 +553,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1003
Private
build Tasks Queue Options
@@ -511,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:600
Private
check And Emit Dynamic Worker Creation Events
@@ -519,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1568
Private
check And Emit Task Execution Events
@@ -527,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1556
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:1562
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:494
Private
check Number Of Workers
@@ -597,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:170
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:188
Private
check Valid Worker Choice Strategy Options
@@ -649,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
choose Worker Node
@@ -662,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1160
Protected
create And Setup Dynamic Worker Node
@@ -674,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1250
Protected
create And Setup Worker Node
@@ -686,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1206
Protected
Abstract
create Worker
@@ -698,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
@@ -711,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
@@ -742,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
@@ -782,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
@@ -837,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1646
Protected
flush Tasks Queue
@@ -850,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1666
Private
flush Tasks Queues
@@ -858,7 +912,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1676
Protected
get Worker Info
@@ -878,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1582
Private
get Worker Node Key By Worker
@@ -898,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:513
Private
get Worker Node Key By Worker Id
@@ -910,7 +964,7 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | number
@@ -918,7 +972,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:525
Private
handle Task Execution Response
@@ -931,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
@@ -944,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1512
Private
has Back Pressure
@@ -952,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
@@ -985,7 +1068,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
Abstract
is Main
@@ -996,20 +1079,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:835
Private
redistribute Queued Tasks
@@ -1022,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
@@ -1062,7 +1185,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1305
+
Private
remove Worker Node
@@ -1081,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
@@ -1115,7 +1257,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1371
Private
send Statistics Message To Worker
@@ -1134,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
@@ -1163,7 +1333,36 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1188
+
+set Default Task Function
+
+
+Private
set Task Stealing
+
+set Task Stealing ( ) : void
+
+Returns void
+Defined in src/pools/abstract-pool.ts:579
Private
set Tasks Queue Size
@@ -1196,7 +1395,15 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:614
+
+Private
set Tasks Stealing On Back Pressure
+
+set Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1253,7 +1460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:987
Private
shall Create Dynamic Worker
@@ -1265,7 +1472,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1177
Private
shall Execute Task
@@ -1278,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
@@ -1298,15 +1505,19 @@ Can be overridden.
-
+
+start
+
+start ( ) : void
-Returns void
+Defined in src/pools/abstract-pool.ts:924
Private
task Stealing On Empty Queue
@@ -1319,7 +1530,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1430
Private
tasks Queue Size
@@ -1332,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1662
Private
tasks Stealing On Back Pressure
@@ -1345,7 +1556,23 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1458
+
+Private
unset Task Stealing
+
+unset Task Stealing ( ) : void
+
+Returns void
+
+Private
unset Tasks Stealing On Back Pressure
+
+unset Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
Private
update Elu Worker Usage
@@ -1360,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
@@ -1375,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
@@ -1390,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
@@ -1405,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1411
Private
update Wait Time Worker Usage
@@ -1420,34 +1647,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1477,6 +1693,7 @@ Can be overridden.
start Timestamp
started
starting
+task Functions
worker Choice Strategy Context
worker Nodes
busy
@@ -1488,6 +1705,7 @@ Can be overridden.
type
utilization
worker
+add Task Function
add Worker Node
after Task Execution Hook
after Worker Node Setup
@@ -1496,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
@@ -1523,37 +1739,48 @@ 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
+set Tasks Stealing On Back Pressure
set Worker Choice Strategy
set Worker Choice Strategy Options
setup Hook
shall Create Dynamic Worker
shall Execute Task
shall Update Task Function Worker Usage
-start Pool
+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