X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=30969c24eba5305e5ab3a9f7431500638caca2a7;hb=bfc75ccaf49d915d2b7e73c92360787b3245321a;hp=779ee93646effb18cf2db2facd60b6ff67435493;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 779ee936..30969c24 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.37
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:60
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Methods
-add Worker Node
+
add Task Function
+
add Worker Node
after Task Execution Hook
after Worker Node Setup
before Task Execution Hook
@@ -107,6 +109,7 @@
create And Setup Dynamic Worker Node
create And Setup Worker Node
create Worker
+
delete Task Function Worker Usages
dequeue Task
destroy
destroy Worker Node
@@ -122,29 +125,38 @@
handle Task Execution Response
handle Worker Ready Response
has Back Pressure
+
has Task Function
has Worker Node Back Pressure
internal Busy
is Main
-
list Task Functions
+
list Task Function Names
redistribute Queued Tasks
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 Tasks Queue Max Size
+
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
@@ -155,7 +167,7 @@
Constructors
-constructor
+constructor
new Abstract Pool < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -176,19 +188,22 @@
numberOfWorkers : number
+
+
filePath : string
+
+
+
+
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:122
Protected
Readonly
file Path
file Path : string
@@ -217,7 +232,7 @@
+Defined in src/pools/abstract-pool.ts:124
Protected
Optional
Readonly
max
max ?: number
@@ -225,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -233,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:123
Protected
Readonly
opts
@@ -241,11 +256,11 @@
+Defined in src/pools/abstract-pool.ts:125
Protected
promise Response Map
-
+Defined in src/pools/abstract-pool.ts:113
Private
started
started : boolean
@@ -270,15 +285,27 @@
+Defined in src/pools/abstract-pool.ts:105
-Private
Readonly
starting
+Private
starting
starting : boolean
+Defined in src/pools/abstract-pool.ts:109
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -286,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:84
Readonly
Internal
worker Nodes
@@ -295,7 +322,7 @@
+Defined in src/pools/abstract-pool.ts:66
Protected
full
@@ -321,7 +348,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:732
+Defined in src/pools/abstract-pool.ts:352
Protected
max Size
@@ -344,7 +371,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:565
Protected
min Size
@@ -355,7 +382,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:558
Private
ready
@@ -366,7 +393,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:510
Protected
Abstract
type
@@ -378,7 +405,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:548
+Defined in src/pools/abstract-pool.ts:527
Protected
Abstract
worker
@@ -401,9 +428,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:553
Methods
+
Private
add Worker Node
@@ -417,14 +475,15 @@
worker : Worker
+
+
Returns number The added worker node key.
+Defined in src/pools/abstract-pool.ts:1624
Protected
after Task Execution Hook
@@ -439,15 +498,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1090
Protected
after Worker Node Setup
@@ -462,11 +523,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1374
Protected
before Task Execution Hook
@@ -481,15 +543,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1060
Private
build Tasks Queue Options
@@ -502,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:681
Private
check And Emit Dynamic Worker Creation Events
@@ -510,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1599
Private
check And Emit Task Execution Events
@@ -518,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1587
Private
check And Emit Task Queuing Events
@@ -526,7 +590,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1593
Protected
check Dynamic Pool Size
@@ -541,7 +605,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:197
Private
check File Path
@@ -554,7 +618,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:166
Private
check Message Worker Id
@@ -568,13 +632,14 @@ Can be overridden.
message : MessageValue < Response , unknown >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:575
Private
check Number Of Workers
@@ -587,7 +652,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
check Pool Options
@@ -600,7 +665,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:223
Private
check Valid Tasks Queue Options
@@ -613,7 +678,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:314
Private
check Valid Worker Choice Strategy
@@ -626,7 +691,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:254
Private
check Valid Worker Choice Strategy Options
@@ -639,7 +704,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:267
Private
choose Worker Node
@@ -652,7 +717,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1217
Protected
create And Setup Dynamic Worker Node
@@ -664,7 +729,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1307
Protected
create And Setup Worker Node
@@ -676,7 +741,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1263
Protected
Abstract
create Worker
@@ -688,7 +753,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1256
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -701,7 +779,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1689
+Defined in src/pools/abstract-pool.ts:1000
Protected
Abstract
destroy Worker Node
@@ -727,11 +805,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:1036
enable Tasks Queue
@@ -745,16 +824,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:646
Private
enqueue Task
@@ -769,7 +850,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1683
execute
@@ -783,21 +864,24 @@ 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:930
Private
execute Task
@@ -811,15 +895,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1677
Protected
flush Tasks Queue
@@ -832,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1697
Private
flush Tasks Queues
@@ -840,11 +926,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1707
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
+get Worker Info ( workerNodeKey ) : WorkerInfo
@@ -854,12 +940,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
+Defined in src/pools/abstract-pool.ts:1613
Private
get Worker Node Key By Worker
@@ -873,12 +960,13 @@ 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:594
Private
get Worker Node Key By Worker Id
@@ -890,14 +978,15 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | 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:606
Private
handle Task Execution Response
@@ -910,7 +999,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1559
Private
handle Worker Ready Response
@@ -923,7 +1012,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1543
Private
has Back Pressure
@@ -931,7 +1020,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1662
+
has Worker Node Back Pressure
@@ -945,13 +1055,14 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true
if the worker node has back pressure, false
otherwise.
+Defined in src/pools/abstract-pool.ts:1655
Protected
internal Busy
@@ -963,7 +1074,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:748
Protected
Abstract
is Main
@@ -974,20 +1085,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:895
Private
redistribute Queued Tasks
@@ -1000,7 +1111,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1417
Protected
Abstract
register Worker Message Listener
@@ -1019,11 +1130,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
+
@@ -1038,7 +1151,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
+
Private
remove Worker Node
@@ -1052,26 +1186,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1646
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:1010
Protected
Abstract
send Startup Message To Worker
@@ -1085,11 +1218,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1398
Private
send Statistics Message To Worker
@@ -1103,11 +1237,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1405
+
+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
@@ -1121,32 +1284,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional
transferList : TransferListItem []
Optional
+
+
Returns void
-
-Private
set Tasks Queue Max Size
-
+
+set Default Task Function
+
+set Default Task Function ( name ) : Promise < boolean >
+
+name : string
+
+
+Returns Promise < boolean > true
if the default task function was set, false
otherwise.
+
+
+
+Private
set Task Stealing
+
+set Task Stealing ( ) : void
+
Returns void
+Defined in src/pools/abstract-pool.ts:701
set Tasks Queue Options
@@ -1160,12 +1342,34 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:660
+
+Private
set Tasks Queue Size
+
+set Tasks Queue Size ( size ) : void
+
+
+Returns void
+
+Private
set Tasks Stealing On Back Pressure
+
+set Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
set Worker Choice Strategy
@@ -1179,16 +1383,18 @@ 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:613
set Worker Choice Strategy Options
@@ -1202,12 +1408,13 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:632
Protected
setup Hook
@@ -1219,7 +1426,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1044
Private
shall Create Dynamic Worker
@@ -1231,7 +1438,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1234
Private
shall Execute Task
@@ -1244,7 +1451,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:921
Private
shall Update Task Function Worker Usage
@@ -1258,20 +1465,25 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true
if the worker node shall update its task function worker usage, false
otherwise.
-
+
+start
+
+start ( ) : void
-Returns void
+Defined in src/pools/abstract-pool.ts:984
Private
task Stealing On Empty Queue
@@ -1284,7 +1496,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1457
Private
tasks Queue Size
@@ -1297,7 +1509,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1693
Private
tasks Stealing On Back Pressure
@@ -1310,7 +1522,23 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1485
+
+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
@@ -1325,7 +1553,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1177
Private
update Run Time Worker Usage
@@ -1340,7 +1568,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
update Task Statistics Worker Usage
@@ -1355,7 +1583,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1132
Private
update Task Stolen Statistics Worker Usage
@@ -1370,7 +1598,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1438
Private
update Wait Time Worker Usage
@@ -1385,7 +1613,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:1164
Protected
worker Listener
@@ -1412,20 +1640,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1525
+poolifier - v2.7.0
+
-
\ No newline at end of file
+
\ No newline at end of file
Number of workers that this pool should manage.
-