X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=5aa31a743fde300612ae89a242b809ae7db083ed;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=46e29227a97fe04f886969199f1c14338af50543;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..4f501d6f 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.30
@@ -49,32 +49,34 @@
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 >
@@ -185,28 +203,29 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:127
Protected
Optional
Readonly
max
max ?: number
@@ -222,7 +241,7 @@
+
Defined in src/pools/abstract-pool.ts:79
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -230,7 +249,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -238,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
+
+
-Private
Readonly
starting
+Private
starting
starting : boolean
+
Defined in src/pools/abstract-pool.ts:114
+
+Private
Readonly
task Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -275,7 +314,7 @@
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
worker Nodes
@@ -284,7 +323,7 @@
+
Defined in src/pools/abstract-pool.ts:71
Protected
full
@@ -310,7 +349,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:659
+
Defined in src/pools/abstract-pool.ts:272
Protected
max Size
@@ -333,7 +372,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:485
Protected
min Size
@@ -344,7 +383,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -355,7 +394,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -367,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
@@ -390,9 +429,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:473
+
Defined in src/pools/abstract-pool.ts:1613
Protected
after Task Execution Hook
@@ -439,7 +509,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1041
Protected
after Worker Node Setup
@@ -459,7 +529,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1354
Protected
before Task Execution Hook
@@ -484,7 +554,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1011
Private
build Tasks Queue Options
@@ -497,7 +567,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:598
Private
check And Emit Dynamic Worker Creation Events
@@ -505,7 +575,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1588
Private
check And Emit Task Execution Events
@@ -513,7 +583,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1576
Private
check And Emit Task Queuing Events
@@ -521,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
@@ -561,7 +603,7 @@ Can be overridden.
Parameters
@@ -570,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:495
Private
check Number Of Workers
@@ -583,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
check Pool Options
@@ -596,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
@@ -635,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
choose Worker Node
@@ -648,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1168
Protected
create And Setup Dynamic Worker Node
@@ -660,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1258
Protected
create And Setup Worker Node
@@ -672,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1214
Protected
Abstract
create Worker
@@ -684,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
@@ -697,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
@@ -728,32 +797,32 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:987
enable Tasks Queue
enable Tasks Queue ( enable , tasksQueueOptions ? ) : void
-
@@ -904,7 +986,33 @@ Can be overridden.
+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
@@ -917,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
@@ -930,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1532
Private
has Back Pressure
@@ -938,7 +1046,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1655
+
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1648
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -971,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:675
Protected
Abstract
is Main
@@ -982,20 +1119,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:843
Private
redistribute Queued Tasks
@@ -1008,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
@@ -1048,7 +1225,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1315
+
Private
remove Worker Node
@@ -1067,22 +1265,20 @@ Can be overridden.
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
@@ -1101,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1385
Private
send Statistics Message To Worker
@@ -1120,7 +1316,35 @@ Can be overridden.
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
@@ -1149,27 +1373,77 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
+
+set Default Task Function
+
+
+Private
set Task Stealing
+
+set Task Stealing ( ) : void
+
+Returns void
set Tasks Queue Options
set Tasks Queue Options ( tasksQueueOptions ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1128
Private
update Run Time Worker Usage
@@ -1309,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
@@ -1324,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
@@ -1339,39 +1661,28 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
+poolifier - v3.0.4
+
-
\ 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 >= pool maximum size^2).'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
file