X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=c5225675ab7e6ec74e0a984e4f66eedd11108212;hb=728b7bbdfbaf327a620aae50beb974b15a0a33d2;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=fa5bdff51f129cada6116f34289dfe5a16bb4c9e;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..c5225675 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.30
+AbstractPool | poolifier - v2.6.36
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:58
filePath : string
-
+
-
+
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:114
Properties
@@ -197,16 +198,16 @@
'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.
'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:67
Protected
Readonly
file Path
file Path : string
@@ -214,7 +215,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max ?: number
@@ -222,7 +223,7 @@
+Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -230,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -238,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promise Response Map
@@ -251,7 +252,7 @@
+Defined in src/pools/abstract-pool.ts:77
Private
Readonly
start Timestamp
start Timestamp : number
@@ -259,7 +260,15 @@
+Defined in src/pools/abstract-pool.ts:105
+
+Private
started
+started : boolean
+
+
Private
Readonly
starting
starting : boolean
@@ -267,7 +276,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
worker Choice Strategy Context
@@ -275,7 +284,7 @@
+Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
worker Nodes
@@ -284,7 +293,7 @@
+Defined in src/pools/abstract-pool.ts:64
Protected
full
@@ -310,7 +319,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:688
+Defined in src/pools/abstract-pool.ts:349
Protected
max Size
@@ -333,7 +342,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:561
Protected
min Size
@@ -344,7 +353,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:554
Private
ready
@@ -355,7 +364,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:506
Protected
Abstract
type
@@ -367,7 +376,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:544
+Defined in src/pools/abstract-pool.ts:523
Protected
Abstract
worker
@@ -390,7 +399,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:549
Protected
after Task Execution Hook
@@ -429,17 +437,15 @@ Can be overridden.
workerNodeKey : number
-
+
message : MessageValue < Response , unknown >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:881
Protected
after Worker Node Setup
@@ -454,12 +460,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1155
Protected
before Task Execution Hook
@@ -474,17 +479,15 @@ Can be overridden.
workerNodeKey : number
-
+
task : Task < Data >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:851
Private
build Tasks Queue Options
@@ -497,7 +500,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:671
Private
check And Emit Dynamic Worker Creation Events
@@ -505,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1409
Private
check And Emit Task Execution Events
@@ -513,7 +516,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1397
Private
check And Emit Task Queuing Events
@@ -521,7 +524,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1403
Protected
check Dynamic Pool Size
@@ -536,7 +539,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:186
Private
check File Path
@@ -549,7 +552,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:155
Private
check Message Worker Id
@@ -563,14 +566,13 @@ Can be overridden.
message : MessageValue < Response , unknown >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:571
Private
check Number Of Workers
@@ -583,7 +585,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:168
Private
check Pool Options
@@ -596,7 +598,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:212
Private
check Valid Tasks Queue Options
@@ -606,10 +608,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:294
Private
check Valid Worker Choice Strategy
@@ -622,7 +624,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:240
Private
check Valid Worker Choice Strategy Options
@@ -635,7 +637,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:250
Private
choose Worker Node
@@ -648,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1008
Protected
create And Setup Dynamic Worker Node
@@ -660,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1098
Protected
create And Setup Worker Node
@@ -672,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1054
Protected
Abstract
create Worker
@@ -684,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1047
Private
dequeue Task
@@ -697,7 +699,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1500
+Defined in src/pools/abstract-pool.ts:796
Protected
Abstract
destroy Worker Node
@@ -723,37 +725,34 @@ Can be overridden.
workerNodeKey : number
-
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:827
enable Tasks Queue
enable Tasks Queue ( enable , tasksQueueOptions ? ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:642
Private
enqueue Task
@@ -768,7 +767,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1494
execute
@@ -782,24 +781,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:738
Private
execute Task
@@ -813,17 +809,15 @@ Can be overridden.
workerNodeKey : number
-
+
task : Task < Data >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1488
Protected
flush Tasks Queue
@@ -836,7 +830,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1508
Private
flush Tasks Queues
@@ -844,11 +838,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1518
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : WorkerInfo
+get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
@@ -858,13 +852,12 @@ Can be overridden.
workerNodeKey : number
-
-The worker information.
+
+The worker information.
+Defined in src/pools/abstract-pool.ts:1423
Private
get Worker Node Key By Worker
@@ -878,13 +871,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:590
Private
get Worker Node Key By Worker Id
@@ -898,13 +890,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:602
Private
handle Task Execution Response
@@ -917,7 +908,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1369
Private
handle Worker Ready Response
@@ -930,7 +921,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1355
Private
has Back Pressure
@@ -938,7 +929,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1473
has Worker Node Back Pressure
@@ -952,14 +943,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:1466
Protected
internal Busy
@@ -971,7 +961,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:704
Protected
Abstract
is Main
@@ -982,7 +972,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:842
+Defined in src/pools/abstract-pool.ts:725
Private
redistribute Queued Tasks
@@ -1008,7 +998,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1195
Protected
Abstract
register Worker Message Listener
@@ -1027,13 +1017,11 @@ Can be overridden.
workerNodeKey : number
-
+
listener : ( ( message ) => void )
-
@@ -1048,7 +1036,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1142
Private
remove Worker Node
@@ -1062,12 +1050,11 @@ Can be overridden.
worker : Worker
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1457
Protected
send Kill Message To Worker
@@ -1082,7 +1069,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:806
Protected
Abstract
send Startup Message To Worker
@@ -1096,12 +1083,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1175
Private
send Statistics Message To Worker
@@ -1115,12 +1101,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Protected
Abstract
send To Worker
@@ -1134,42 +1119,51 @@ Can be overridden.
workerNodeKey : number
-
+
-
+
Optional
transferList : TransferListItem []
-
+Optional
Returns void
+Defined in src/pools/abstract-pool.ts:1036
+
+Private
set Tasks Queue Max Size
+
+set Tasks Queue Max Size ( size ) : void
+
+
+Returns void
set Tasks Queue Options
set Tasks Queue Options ( tasksQueueOptions ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:654
set Worker Choice Strategy
@@ -1183,18 +1177,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:609
set Worker Choice Strategy Options
@@ -1208,13 +1200,12 @@ Can be overridden.
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:628
Protected
setup Hook
@@ -1226,7 +1217,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:835
Private
shall Create Dynamic Worker
@@ -1238,7 +1229,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1025
Private
shall Update Task Function Worker Usage
@@ -1252,13 +1243,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:914
Private
start Pool
@@ -1266,7 +1256,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:336
+
+Private
task Stealing On Empty Queue
+
+task Stealing On Empty Queue ( workerId ) : void
+
+
+Returns void
Private
tasks Queue Size
@@ -1279,7 +1282,20 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1504
+
+Private
tasks Stealing On Back Pressure
+
+tasks Stealing On Back Pressure ( workerId ) : void
+
+
+Returns void
Private
update Elu Worker Usage
@@ -1294,7 +1310,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:968
Private
update Run Time Worker Usage
@@ -1309,7 +1325,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:941
Private
update Task Statistics Worker Usage
@@ -1324,7 +1340,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:923
Private
update Wait Time Worker Usage
@@ -1339,7 +1355,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:955
Protected
worker Listener
@@ -1366,7 +1382,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1335
+Generated using TypeDoc
\ No newline at end of file
Number of workers that this pool should manage.
-