X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=60e3c607794b436d8df80a4558cc8b5d41771dd4;hb=1b27b0580ef80da95449c262682015a6da19e226;hp=22404f94128b9da75cebadc0a110390c1c442f0e;hpb=f2d2c4a40a1d1652ba5fb0dee4b6aa3387321c92;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 22404f94..60e3c607 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.34
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:66
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
new Abstract Pool < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -189,19 +203,20 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -234,7 +249,7 @@
+
Defined in src/pools/abstract-pool.ts:129
Protected
Readonly
opts
@@ -242,11 +257,11 @@
+
Defined in src/pools/abstract-pool.ts:131
Protected
promise Response Map
-
+
Defined in src/pools/abstract-pool.ts:119
Private
started
started : boolean
@@ -271,15 +286,27 @@
+
Defined in src/pools/abstract-pool.ts:111
-Private
Readonly
starting
+Private
starting
starting : boolean
+
Defined in src/pools/abstract-pool.ts:115
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -287,7 +314,7 @@
+Defined in src/pools/abstract-pool.ts:95
Readonly
Internal
worker Nodes
@@ -296,7 +323,7 @@
+
Defined in src/pools/abstract-pool.ts:72
Protected
full
@@ -322,7 +349,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:660
+
Defined in src/pools/abstract-pool.ts:273
Protected
max Size
@@ -345,7 +372,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:486
Protected
min Size
@@ -356,7 +383,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:479
Private
ready
@@ -367,7 +394,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:431
Protected
Abstract
type
@@ -379,7 +406,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:469
+
Defined in src/pools/abstract-pool.ts:448
Protected
Abstract
worker
@@ -402,9 +429,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:474
+
Defined in src/pools/abstract-pool.ts:1619
Protected
after Task Execution Hook
@@ -451,7 +509,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1043
Protected
after Worker Node Setup
@@ -471,7 +529,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1356
Protected
before Task Execution Hook
@@ -496,7 +554,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1013
Private
build Tasks Queue Options
@@ -509,7 +567,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:599
Private
check And Emit Dynamic Worker Creation Events
@@ -517,7 +575,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1594
Private
check And Emit Task Execution Events
@@ -525,7 +583,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1582
Private
check And Emit Task Queuing Events
@@ -533,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:1588
Private
check Message Worker Id
@@ -573,7 +603,7 @@ Can be overridden.
Parameters
@@ -582,7 +612,7 @@ Can be overridden.
Throws https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Defined in src/pools/abstract-pool.ts:496
Private
check Number Of Workers
@@ -595,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:172
Private
check Pool Options
@@ -608,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:190
Private
check Valid Worker Choice Strategy Options
@@ -647,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:219
Private
choose Worker Node
@@ -660,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1170
Protected
create And Setup Dynamic Worker Node
@@ -672,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1260
Protected
create And Setup Worker Node
@@ -684,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1216
Protected
Abstract
create Worker
@@ -696,7 +700,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1209
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -709,7 +726,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1688
+
+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:949
Protected
Abstract
destroy Worker Node
@@ -740,7 +797,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:989
+Defined in src/pools/abstract-pool.ts:564
Private
enqueue Task
@@ -780,7 +837,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1682
+Defined in src/pools/abstract-pool.ts:879
Private
execute Task
@@ -835,7 +892,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1676
+
+Protected
flag Worker Node As Not Ready
+
+flag Worker Node As Not Ready ( workerNodeKey ) : void
+
+
+Returns void
Protected
flush Tasks Queue
@@ -848,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1696
Private
flush Tasks Queues
@@ -856,11 +926,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1706
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
+get Worker Info ( workerNodeKey ) : WorkerInfo
@@ -872,11 +942,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1608
Private
get Worker Node Key By Worker
@@ -896,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:512
Private
get Worker Node Key By Worker Id
@@ -908,7 +978,7 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | number
@@ -916,7 +986,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:524
+
+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
@@ -929,7 +1025,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1554
Private
handle Worker Ready Response
@@ -942,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1534
Private
has Back Pressure
@@ -950,7 +1046,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1661
+
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1654
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -983,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:676
Protected
Abstract
is Main
@@ -994,20 +1119,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:844
Private
redistribute Queued Tasks
@@ -1020,7 +1145,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1406
+
+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
@@ -1060,7 +1225,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1317
+
Private
remove Worker Node
@@ -1079,22 +1265,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1641
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:960
Protected
Abstract
send Startup Message To Worker
@@ -1113,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1387
Private
send Statistics Message To Worker
@@ -1132,7 +1316,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1394
+
+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
@@ -1161,20 +1373,36 @@ Can be overridden.
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:619
+Defined in src/pools/abstract-pool.ts:578
+
+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
+Defined in src/pools/abstract-pool.ts:531
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:550
Protected
setup Hook
@@ -1251,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:997
Private
shall Create Dynamic Worker
@@ -1263,7 +1512,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1187
+
+Private
shall Execute Task
+
+shall Execute Task ( workerNodeKey ) : boolean
+
+
+Returns boolean
Private
shall Update Task Function Worker Usage
@@ -1283,28 +1545,19 @@ Can be overridden.
-
-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:933
Private
tasks Queue Size
@@ -1317,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
+
+Private
unset Tasks Stealing On Back Pressure
+
+unset Tasks Stealing On Back Pressure ( ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:646
Private
update Elu Worker Usage
@@ -1345,7 +1601,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1130
Private
update Run Time Worker Usage
@@ -1360,7 +1616,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1103
Private
update Task Statistics Worker Usage
@@ -1375,7 +1631,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1085
+
+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
@@ -1390,39 +1661,28 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
+poolifier - v3.0.5
+
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
Emitter on which events can be listened to.
+
+Optional
emitterEvent emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
'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.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'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).Protected
Readonly
fileProtected
Optional
Readonly
max