X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=614932c4077a7ef3a0b701b8ab427fe9e38fa650;hb=59ce75a1e75c675c4cd9cd1908522c4ce144fd85;hp=c5225675ab7e6ec74e0a984e4f66eedd11108212;hpb=323daa7f98fd16385379e4b6e8def0a9a3f140c8;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index c5225675..614932c4 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.36
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:65
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
new Abstract Pool < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -174,29 +188,33 @@
numberOfWorkers : number
+
+
filePath : string
+
+
+
+
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -231,7 +249,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -239,11 +257,11 @@
+Defined in src/pools/abstract-pool.ts:130
Protected
promise Response Map
-
+Defined in src/pools/abstract-pool.ts:118
Private
started
started : boolean
@@ -268,15 +286,27 @@
+Defined in src/pools/abstract-pool.ts:110
-Private
Readonly
starting
+Private
starting
starting : boolean
+Defined in src/pools/abstract-pool.ts:114
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -284,7 +314,7 @@
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
worker Nodes
@@ -293,7 +323,7 @@
+Defined in src/pools/abstract-pool.ts:71
Protected
full
@@ -319,7 +349,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:659
+Defined in src/pools/abstract-pool.ts:272
Protected
max Size
@@ -342,7 +372,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:485
Protected
min Size
@@ -353,7 +383,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -364,7 +394,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -376,7 +406,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -399,9 +429,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:473
Methods
+
Private
add Worker Node
@@ -415,14 +476,15 @@
worker : Worker
+
+
Returns number The added worker node key.
+Defined in src/pools/abstract-pool.ts:1613
Protected
after Task Execution Hook
@@ -437,15 +499,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1041
Protected
after Worker Node Setup
@@ -460,11 +524,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1354
Protected
before Task Execution Hook
@@ -479,15 +544,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1011
Private
build Tasks Queue Options
@@ -500,7 +567,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:598
Private
check And Emit Dynamic Worker Creation Events
@@ -508,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1588
Private
check And Emit Task Execution Events
@@ -516,7 +583,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1576
Private
check And Emit Task Queuing Events
@@ -524,35 +591,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:1582
Private
check Message Worker Id
@@ -564,15 +603,16 @@ Can be overridden.
Parameters
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:495
Private
check Number Of Workers
@@ -585,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
check Pool Options
@@ -598,33 +638,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:189
Private
check Valid Worker Choice Strategy Options
@@ -637,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
choose Worker Node
@@ -650,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1168
Protected
create And Setup Dynamic Worker Node
@@ -662,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1258
Protected
create And Setup Worker Node
@@ -674,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1214
Protected
Abstract
create Worker
@@ -686,7 +700,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1207
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -699,7 +726,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1682
+
+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:948
Protected
Abstract
destroy Worker Node
@@ -725,11 +792,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:987
enable Tasks Queue
@@ -743,16 +811,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:563
Private
enqueue Task
@@ -767,7 +837,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1676
execute
@@ -781,21 +851,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:878
Private
execute Task
@@ -809,15 +882,30 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1670
+
+Protected
flag Worker Node As Not Ready
+
+flag Worker Node As Not Ready ( workerNodeKey ) : void
+
+
+Returns void
Protected
flush Tasks Queue
@@ -830,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1690
Private
flush Tasks Queues
@@ -838,11 +926,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1700
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
+get Worker Info ( workerNodeKey ) : WorkerInfo
@@ -852,12 +940,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
+Defined in src/pools/abstract-pool.ts:1602
Private
get Worker Node Key By Worker
@@ -871,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:511
Private
get Worker Node Key By Worker Id
@@ -888,14 +978,41 @@ 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:523
+
+Private
Readonly
handle Back Pressure Event
+
+handle Back Pressure Event ( event ) : void
+
+
+Returns void
+
+Private
Readonly
handle Empty Queue Event
+
+handle Empty Queue Event ( event ) : void
+
+
+Returns void
Private
handle Task Execution Response
@@ -908,7 +1025,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1548
Private
handle Worker Ready Response
@@ -921,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1532
Private
has Back Pressure
@@ -929,7 +1046,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1655
+
has Worker Node Back Pressure
@@ -943,13 +1081,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:1648
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -961,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:675
Protected
Abstract
is Main
@@ -972,20 +1119,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:843
Private
redistribute Queued Tasks
@@ -998,7 +1145,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1404
+
+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
@@ -1017,11 +1204,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
+
@@ -1036,7 +1225,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1315
+
Private
remove Worker Node
@@ -1050,26 +1260,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1635
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:959
Protected
Abstract
send Startup Message To Worker
@@ -1083,11 +1292,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1385
Private
send Statistics Message To Worker
@@ -1101,11 +1311,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1392
+
+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
@@ -1119,32 +1358,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:618
set Tasks Queue Options
@@ -1158,12 +1416,34 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:577
+
+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
@@ -1177,16 +1457,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:530
set Worker Choice Strategy Options
@@ -1200,12 +1482,13 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:549
Protected
setup Hook
@@ -1217,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private
shall Create Dynamic Worker
@@ -1229,7 +1512,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1185
+
+Private
shall Execute Task
+
+shall Execute Task ( workerNodeKey ) : boolean
+
+
+Returns boolean
Private
shall Update Task Function Worker Usage
@@ -1243,33 +1539,25 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true
if the worker node shall update its task function worker usage, false
otherwise.
-
-Private
start Pool
-
-start Pool ( ) : void
-
-Returns void
-
-Private
task Stealing On Empty Queue
-
+
+start
+
+start ( ) : void
-
-Returns void
+Defined in src/pools/abstract-pool.ts:932
Private
tasks Queue Size
@@ -1282,20 +1570,23 @@ Can be overridden.
workerNodeKey : number
Returns number
-
+
+Private
unset Task Stealing
-tasks Stealing On Back Pressure ( workerId ) : void
+unset Task Stealing ( ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:627
+
+Private
unset Tasks Stealing On Back Pressure
+
+unset Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
Private
update Elu Worker Usage
@@ -1310,7 +1601,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1128
Private
update Run Time Worker Usage
@@ -1325,7 +1616,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1101
Private
update Task Statistics Worker Usage
@@ -1340,7 +1631,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1083
+
+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
@@ -1355,39 +1661,28 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
+poolifier - v3.0.3
+
-
\ No newline at end of file
+
\ No newline at end of file
Number of workers that this pool should manage.
-