X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=92d46d153c26a6e332bce691985d560adac71ee5;hb=8974e0633f6c99528bf3590e7c76820b2c69d3e2;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=a25c335d7e5573a171fc96c445cb6092852b2c4a;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..92d46d15 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.30
+AbstractPool | poolifier - v2.6.40
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:57
@@ -170,22 +176,19 @@
numberOfWorkers : number
-
+
filePath : string
-
+
-
+
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:113
Properties
@@ -195,18 +198,18 @@
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.
-'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
+'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
-'destroy
': Emitted when the pool is destroyed.
+'destroy'
: Emitted when the pool is destroyed.
'error'
: Emitted when an uncaught error occurs.
'taskError'
: Emitted when an error occurs while executing a task.
-'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= pool maximum size^2).
+'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
+Defined in src/pools/abstract-pool.ts:66
Protected
Readonly
file Path
file Path : string
@@ -214,7 +217,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Optional
Readonly
max
max ?: number
@@ -222,7 +225,7 @@
+Defined in src/pools/abstract-pool.ts:91
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -230,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
opts
@@ -238,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
promise Response Map
@@ -251,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private
Readonly
start Timestamp
start Timestamp : number
@@ -259,7 +262,15 @@
+Defined in src/pools/abstract-pool.ts:104
+
+Private
started
+started : boolean
+
+
Private
Readonly
starting
starting : boolean
@@ -267,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
worker Choice Strategy Context
@@ -275,7 +286,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly
Internal
worker Nodes
@@ -284,7 +295,7 @@
+Defined in src/pools/abstract-pool.ts:63
Protected
full
@@ -310,7 +321,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:687
+Defined in src/pools/abstract-pool.ts:348
Protected
max Size
@@ -333,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:560
Protected
min Size
@@ -344,7 +355,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:553
Private
ready
@@ -355,7 +366,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:505
Protected
Abstract
type
@@ -367,7 +378,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:522
Protected
Abstract
worker
@@ -390,7 +401,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:548
Protected
after Task Execution Hook
@@ -429,17 +439,15 @@ Can be overridden.
workerNodeKey : number
-
+
message : MessageValue < Response , unknown >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:886
Protected
after Worker Node Setup
@@ -454,12 +462,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1160
Protected
before Task Execution Hook
@@ -474,17 +481,15 @@ Can be overridden.
workerNodeKey : number
-
+
task : Task < Data >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:856
Private
build Tasks Queue Options
@@ -497,7 +502,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:670
Private
check And Emit Dynamic Worker Creation Events
@@ -505,7 +510,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1403
Private
check And Emit Task Execution Events
@@ -513,7 +518,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1391
Private
check And Emit Task Queuing Events
@@ -521,7 +526,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1397
Protected
check Dynamic Pool Size
@@ -536,7 +541,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private
check File Path
@@ -549,7 +554,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:154
Private
check Message Worker Id
@@ -563,14 +568,13 @@ Can be overridden.
message : MessageValue < Response , unknown >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:570
Private
check Number Of Workers
@@ -583,7 +587,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
check Pool Options
@@ -596,7 +600,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private
check Valid Tasks Queue Options
@@ -609,7 +613,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private
check Valid Worker Choice Strategy
@@ -622,7 +626,7 @@ Can be overridden.
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:239
Private
check Valid Worker Choice Strategy Options
@@ -635,7 +639,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private
choose Worker Node
@@ -648,7 +652,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1013
Protected
create And Setup Dynamic Worker Node
@@ -660,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1103
Protected
create And Setup Worker Node
@@ -672,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1059
Protected
Abstract
create Worker
@@ -684,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Private
dequeue Task
@@ -697,7 +701,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1493
+Defined in src/pools/abstract-pool.ts:801
Protected
Abstract
destroy Worker Node
@@ -723,37 +727,34 @@ Can be overridden.
workerNodeKey : number
-
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:832
enable Tasks Queue
enable Tasks Queue ( enable , tasksQueueOptions ? ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:641
Private
enqueue Task
@@ -768,7 +769,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1487
execute
@@ -782,24 +783,21 @@ Can be overridden.
Optional
data : Data
-
+Optional
Optional
name : string
-
+Optional
Optional
transferList : TransferListItem []
-
+Optional
Returns Promise < Response > Promise that will be fulfilled when the task is completed.
+Defined in src/pools/abstract-pool.ts:745
Private
execute Task
@@ -813,17 +811,15 @@ Can be overridden.
workerNodeKey : number
-
+
task : Task < Data >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1481
Protected
flush Tasks Queue
@@ -836,7 +832,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1501
Private
flush Tasks Queues
@@ -844,11 +840,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1511
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : WorkerInfo
+get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
@@ -858,13 +854,12 @@ Can be overridden.
workerNodeKey : number
-
-The worker information.
+
+The worker information.
+Defined in src/pools/abstract-pool.ts:1417
Private
get Worker Node Key By Worker
@@ -878,13 +873,12 @@ Can be overridden.
worker : Worker
-
+
Returns number The worker node key if found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:589
Private
get Worker Node Key By Worker Id
@@ -898,13 +892,12 @@ Can be overridden.
workerId : number
-
+
Returns number The worker node key if the worker id is found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:601
Private
handle Task Execution Response
@@ -917,7 +910,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1363
Private
handle Worker Ready Response
@@ -930,7 +923,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1349
Private
has Back Pressure
@@ -938,7 +931,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1466
has Worker Node Back Pressure
@@ -952,14 +945,13 @@ Can be overridden.
workerNodeKey : number
-
+
Returns boolean true
if the worker node has back pressure, false
otherwise.
+Defined in src/pools/abstract-pool.ts:1459
Protected
internal Busy
@@ -971,7 +963,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:703
Protected
Abstract
is Main
@@ -982,7 +974,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:847
+Defined in src/pools/abstract-pool.ts:724
Private
redistribute Queued Tasks
@@ -1008,7 +1000,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1200
Protected
Abstract
register Worker Message Listener
@@ -1027,13 +1019,11 @@ Can be overridden.
workerNodeKey : number
-
+
listener : ( ( message ) => void )
-
@@ -1048,7 +1038,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1147
Private
remove Worker Node
@@ -1062,12 +1052,11 @@ Can be overridden.
worker : Worker
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1450
Protected
send Kill Message To Worker
@@ -1082,7 +1071,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:811
Protected
Abstract
send Startup Message To Worker
@@ -1096,12 +1085,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1180
Private
send Statistics Message To Worker
@@ -1115,12 +1103,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1187
Protected
Abstract
send To Worker
@@ -1134,42 +1121,51 @@ Can be overridden.
workerNodeKey : number
-
+
-
+
Optional
transferList : TransferListItem []
-
+Optional
Returns void
+Defined in src/pools/abstract-pool.ts:1041
set Tasks Queue Options
set Tasks Queue Options ( tasksQueueOptions ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:653
+
+Private
set Tasks Queue Size
+
+set Tasks Queue Size ( size ) : void
+
+
+Returns void
set Worker Choice Strategy
@@ -1183,18 +1179,16 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-
+
-
+Optional
Returns void
+Defined in src/pools/abstract-pool.ts:608
set Worker Choice Strategy Options
@@ -1208,13 +1202,12 @@ Can be overridden.
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:627
Protected
setup Hook
@@ -1226,7 +1219,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:840
Private
shall Create Dynamic Worker
@@ -1238,7 +1231,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1030
+
+Private
shall Execute Task
+
+shall Execute Task ( workerNodeKey ) : boolean
+
+
+Returns boolean
Private
shall Update Task Function Worker Usage
@@ -1252,13 +1258,12 @@ Can be overridden.
workerNodeKey : number
-
+
Returns boolean true
if the worker node shall update its task function worker usage, false
otherwise.
+Defined in src/pools/abstract-pool.ts:919
Private
start Pool
@@ -1266,7 +1271,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:335
+
+Private
task Stealing On Empty Queue
+
+task Stealing On Empty Queue ( workerId ) : void
+
+
+Returns void
Private
tasks Queue Size
@@ -1279,7 +1297,20 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1497
+
+Private
tasks Stealing On Back Pressure
+
+tasks Stealing On Back Pressure ( workerId ) : void
+
+
+Returns void
Private
update Elu Worker Usage
@@ -1294,7 +1325,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:973
Private
update Run Time Worker Usage
@@ -1309,7 +1340,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:946
Private
update Task Statistics Worker Usage
@@ -1324,7 +1355,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:928
+
+Private
update Task Stolen Statistics Worker Usage
+
+update Task Stolen Statistics Worker Usage ( workerNodeKey , taskName ) : void
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+taskName : string
+Returns void
Private
update Wait Time Worker Usage
@@ -1339,7 +1385,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:960
Protected
worker Listener
@@ -1366,7 +1412,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1329
+Generated using TypeDoc
\ No newline at end of file
Number of workers that this pool should manage.
-