X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=5e92789021fa4414e60df74c0dfe581a710f39ce;hb=eedbbd20d7c77c4b62c129ebfa4a4c4a06d5d06a;hp=e2a2a08256775bd466e5b39bf6503bf8743de05c;hpb=da7631f88ed580377ddba0882eac576bb32832eb;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e2a2a082..5e927890 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.41
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:64
- 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
@@ -95,19 +97,17 @@
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
@@ -122,29 +122,40 @@
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
@@ -155,7 +166,7 @@
Constructors
-constructor
+constructor
new Abstract Pool < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -176,25 +187,29 @@
numberOfWorkers : number
+
+
filePath : string
+
+
+
+
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -233,7 +248,7 @@
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -241,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
@@ -270,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
@@ -286,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -295,7 +322,7 @@
+Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -321,7 +348,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:651
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -344,7 +371,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -355,7 +382,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -366,7 +393,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:429
Protected
Abstract
type
@@ -378,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
@@ -401,9 +428,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:472
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:1596
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:1035
Protected
after Worker Node Setup
@@ -462,11 +523,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1346
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:1005
Private
build Tasks Queue Options
@@ -502,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:600
Private
check And Emit Dynamic Worker Creation Events
@@ -510,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1571
Private
check And Emit Task Execution Events
@@ -518,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1559
Private
check And Emit Task Queuing Events
@@ -526,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:1565
Private
check Message Worker Id
@@ -566,15 +602,16 @@ Can be overridden.
Parameters
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:494
Private
check Number Of Workers
@@ -587,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
check Pool Options
@@ -600,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
@@ -639,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
choose Worker Node
@@ -652,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1162
Protected
create And Setup Dynamic Worker Node
@@ -664,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1252
Protected
create And Setup Worker Node
@@ -676,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1208
Protected
Abstract
create Worker
@@ -688,7 +699,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1201
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -701,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1661
+
+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
@@ -727,11 +791,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:981
enable Tasks Queue
@@ -745,16 +810,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:565
Private
enqueue Task
@@ -769,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1655
execute
@@ -783,21 +850,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:870
Private
execute Task
@@ -811,15 +881,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1649
Protected
flush Tasks Queue
@@ -832,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1669
Private
flush Tasks Queues
@@ -840,7 +912,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1679
Protected
get Worker Info
@@ -854,12 +926,13 @@ Can be overridden.
workerNodeKey : number
+
+
The worker information.
+Defined in src/pools/abstract-pool.ts:1585
Private
get Worker Node Key By Worker
@@ -873,12 +946,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:513
Private
get Worker Node Key By Worker Id
@@ -890,14 +964,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:525
Private
handle Task Execution Response
@@ -910,7 +985,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1531
Private
handle Worker Ready Response
@@ -923,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1515
Private
has Back Pressure
@@ -931,7 +1006,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1634
+
has Worker Node Back Pressure
@@ -945,13 +1041,22 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true
if the worker node has back pressure, false
otherwise.
+Defined in src/pools/abstract-pool.ts:1627
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -963,7 +1068,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
Abstract
is Main
@@ -974,20 +1079,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:835
Private
redistribute Queued Tasks
@@ -1000,7 +1105,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1389
+
+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
@@ -1019,11 +1164,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
+
@@ -1038,7 +1185,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1307
+
Private
remove Worker Node
@@ -1052,26 +1220,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1618
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:953
Protected
Abstract
send Startup Message To Worker
@@ -1085,11 +1252,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1370
Private
send Statistics Message To Worker
@@ -1103,11 +1271,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1377
+
+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,19 +1318,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional
transferList : TransferListItem []
Optional
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1190
+
+set Default Task Function
+
+
+Private
set Task Stealing
+
+set Task Stealing ( ) : void
+
+Returns void
set Tasks Queue Options
@@ -1147,12 +1376,13 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:579
Private
set Tasks Queue Size
@@ -1165,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
set Worker Choice Strategy
@@ -1179,16 +1417,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:532
set Worker Choice Strategy Options
@@ -1202,12 +1442,13 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1219,7 +1460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:989
Private
shall Create Dynamic Worker
@@ -1231,7 +1472,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1179
Private
shall Execute Task
@@ -1244,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
@@ -1258,20 +1499,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:924
Private
task Stealing On Empty Queue
@@ -1284,7 +1530,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1429
Private
tasks Queue Size
@@ -1297,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1665
Private
tasks Stealing On Back Pressure
@@ -1310,7 +1556,23 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1457
+
+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 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1122
Private
update Run Time Worker Usage
@@ -1340,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1095
Private
update Task Statistics Worker Usage
@@ -1355,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1077
Private
update Task Stolen Statistics Worker Usage
@@ -1370,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1410
Private
update Wait Time Worker Usage
@@ -1385,7 +1647,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
worker Listener
@@ -1412,20 +1674,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1497
+poolifier - v2.7.3
+
-
\ No newline at end of file
+
\ No newline at end of file
Number of workers that this pool should manage.
-