X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c5225675ab7e6ec74e0a984e4f66eedd11108212;hb=999ef664722a6ef639e3b3a90542e3ed2f38288c;hp=ae49d8ab5bcb884f8fd62c4ab7550406b3c4a34d;hpb=95c333666812f5db34b93c20d8851f2755d1c920;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index ae49d8ab..c5225675 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.34
+AbstractPool | poolifier - v2.6.36
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:58
@@ -174,22 +174,19 @@
numberOfWorkers : number
-
+
filePath : string
-
+
-
+
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:114
Properties
@@ -201,7 +198,7 @@
'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 >= maximum queue size).
@@ -210,7 +207,7 @@
+Defined in src/pools/abstract-pool.ts:67
Protected
Readonly
file Path
file Path : string
@@ -218,7 +215,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max ?: number
@@ -226,7 +223,7 @@
+Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -234,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -242,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promise Response Map
@@ -255,7 +252,7 @@
+Defined in src/pools/abstract-pool.ts:77
Private
Readonly
start Timestamp
start Timestamp : number
@@ -263,7 +260,7 @@
+Defined in src/pools/abstract-pool.ts:105
Private
started
started : boolean
@@ -271,7 +268,7 @@
+Defined in src/pools/abstract-pool.ts:101
Private
Readonly
starting
starting : boolean
@@ -279,7 +276,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
worker Choice Strategy Context
@@ -287,7 +284,7 @@
+Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
worker Nodes
@@ -296,7 +293,7 @@
+Defined in src/pools/abstract-pool.ts:64
Protected
full
@@ -322,7 +319,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:688
+Defined in src/pools/abstract-pool.ts:349
Protected
max Size
@@ -345,7 +342,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:561
Protected
min Size
@@ -356,7 +353,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:554
Private
ready
@@ -367,7 +364,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:506
Protected
Abstract
type
@@ -379,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
@@ -402,7 +399,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:549
Protected
after Task Execution Hook
@@ -441,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
@@ -466,12 +460,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1155
Protected
before Task Execution Hook
@@ -486,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
@@ -509,7 +500,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:671
Private
check And Emit Dynamic Worker Creation Events
@@ -517,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1409
Private
check And Emit Task Execution Events
@@ -525,7 +516,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1397
Private
check And Emit Task Queuing Events
@@ -533,7 +524,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1403
Protected
check Dynamic Pool Size
@@ -548,7 +539,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:186
Private
check File Path
@@ -561,7 +552,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:155
Private
check Message Worker Id
@@ -575,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
@@ -595,7 +585,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:168
Private
check Pool Options
@@ -608,7 +598,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:212
Private
check Valid Tasks Queue Options
@@ -621,7 +611,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:294
Private
check Valid Worker Choice Strategy
@@ -634,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
@@ -647,7 +637,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:250
Private
choose Worker Node
@@ -660,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1008
Protected
create And Setup Dynamic Worker Node
@@ -672,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1098
Protected
create And Setup Worker Node
@@ -684,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1054
Protected
Abstract
create Worker
@@ -696,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1047
Private
dequeue Task
@@ -709,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
@@ -735,12 +725,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:827
enable Tasks Queue
@@ -754,18 +743,16 @@ Can be overridden.
enable : boolean
-
+
-
+Optional
Returns void
+Defined in src/pools/abstract-pool.ts:642
Private
enqueue Task
@@ -780,7 +767,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1494
execute
@@ -794,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
@@ -825,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
@@ -848,7 +830,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1508
Private
flush Tasks Queues
@@ -856,7 +838,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1518
Protected
get Worker Info
@@ -870,13 +852,12 @@ Can be overridden.
workerNodeKey : number
-
+
The worker information.
+Defined in src/pools/abstract-pool.ts:1423
Private
get Worker Node Key By Worker
@@ -890,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
@@ -910,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
@@ -929,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
@@ -942,7 +921,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1355
Private
has Back Pressure
@@ -950,7 +929,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1473
has Worker Node Back Pressure
@@ -964,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
@@ -983,7 +961,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:704
Protected
Abstract
is Main
@@ -994,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
@@ -1020,7 +998,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1195
Protected
Abstract
register Worker Message Listener
@@ -1039,13 +1017,11 @@ Can be overridden.
workerNodeKey : number
-
+
listener : ( ( message ) => void )
-
@@ -1060,7 +1036,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1142
Private
remove Worker Node
@@ -1074,12 +1050,11 @@ Can be overridden.
worker : Worker
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1457
Protected
send Kill Message To Worker
@@ -1094,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
@@ -1108,12 +1083,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1175
Private
send Statistics Message To Worker
@@ -1127,12 +1101,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Protected
Abstract
send To Worker
@@ -1146,22 +1119,19 @@ 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
@@ -1174,7 +1144,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:665
set Tasks Queue Options
@@ -1188,13 +1158,12 @@ Can be overridden.
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:654
set Worker Choice Strategy
@@ -1208,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
@@ -1233,13 +1200,12 @@ Can be overridden.
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:628
Protected
setup Hook
@@ -1251,7 +1217,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:835
Private
shall Create Dynamic Worker
@@ -1263,7 +1229,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1025
Private
shall Update Task Function Worker Usage
@@ -1277,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
@@ -1291,7 +1256,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:336
Private
task Stealing On Empty Queue
@@ -1304,7 +1269,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1230
Private
tasks Queue Size
@@ -1317,7 +1282,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1504
Private
tasks Stealing On Back Pressure
@@ -1330,7 +1295,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1281
Private
update Elu Worker Usage
@@ -1345,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
@@ -1360,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
@@ -1375,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
@@ -1390,7 +1355,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:955
Protected
worker Listener
@@ -1417,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.
-