X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=ed6afb83fa7e1265ba656aaaefb1de57dd51fa5a;hp=afe2c6221532a1589d7361fdc42d6a77401950e2;hpb=603ce450e1c02a53a06aff9e9ba5f3cdee24a3f2;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index afe2c622..072c9da0 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: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 >
@@ -189,19 +202,20 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -234,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -242,11 +256,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
@@ -271,15 +285,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
@@ -287,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
worker Nodes
@@ -296,7 +322,7 @@
+
Defined in src/pools/abstract-pool.ts:71
Protected
full
@@ -322,7 +348,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:662
+
Defined in src/pools/abstract-pool.ts:272
Protected
max Size
@@ -345,7 +371,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:485
Protected
min Size
@@ -356,7 +382,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -367,7 +393,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -379,7 +405,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:468
+
Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -402,9 +428,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:473
+
Defined in src/pools/abstract-pool.ts:1614
Protected
after Task Execution Hook
@@ -451,7 +508,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1044
Protected
after Worker Node Setup
@@ -471,7 +528,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1355
Protected
before Task Execution Hook
@@ -496,7 +553,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1014
Private
build Tasks Queue Options
@@ -509,7 +566,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:601
Private
check And Emit Dynamic Worker Creation Events
@@ -517,7 +574,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1589
Private
check And Emit Task Execution Events
@@ -525,7 +582,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1577
Private
check And Emit Task Queuing Events
@@ -533,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:1583
Private
check Message Worker Id
@@ -573,7 +602,7 @@ Can be overridden.
Parameters
@@ -582,7 +611,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
@@ -595,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
check Pool Options
@@ -608,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:189
Private
check Valid Worker Choice Strategy Options
@@ -647,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
choose Worker Node
@@ -660,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1171
Protected
create And Setup Dynamic Worker Node
@@ -672,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1261
Protected
create And Setup Worker Node
@@ -684,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1217
Protected
Abstract
create Worker
@@ -696,7 +699,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1210
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -709,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1679
+
+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:951
Protected
Abstract
destroy Worker Node
@@ -740,7 +796,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:990
+Defined in src/pools/abstract-pool.ts:566
Private
enqueue Task
@@ -780,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1673
+Defined in src/pools/abstract-pool.ts:881
Private
execute Task
@@ -835,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
flush Tasks Queue
@@ -848,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1687
Private
flush Tasks Queues
@@ -856,11 +912,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1697
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
+get Worker Info ( workerNodeKey ) : WorkerInfo
@@ -872,11 +928,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1603
Private
get Worker Node Key By Worker
@@ -896,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:514
Private
get Worker Node Key By Worker Id
@@ -908,7 +964,7 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | number
@@ -916,7 +972,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:526
+
+Private
Readonly
handle Back Pressure Event
+
+handle Back Pressure Event ( event ) : void
+
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail >
+Returns void
+
+Private
Readonly
handle Empty Queue Event
+
+handle Empty Queue Event ( event ) : void
+
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail >
+Returns void
Private
handle Task Execution Response
@@ -929,7 +1011,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1549
Private
handle Worker Ready Response
@@ -942,7 +1024,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1533
Private
has Back Pressure
@@ -950,7 +1032,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1652
+
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1645
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -983,7 +1094,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:678
Protected
Abstract
is Main
@@ -994,20 +1105,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:846
Private
redistribute Queued Tasks
@@ -1020,7 +1131,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1405
+
+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 +1211,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1316
+
Private
remove Worker Node
@@ -1079,22 +1251,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1636
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:962
Protected
Abstract
send Startup Message To Worker
@@ -1113,7 +1283,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1386
Private
send Statistics Message To Worker
@@ -1132,7 +1302,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1393
+
+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 +1359,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:621
+Defined in src/pools/abstract-pool.ts:580
+
+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:533
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:552
Protected
setup Hook
@@ -1251,7 +1486,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:998
Private
shall Create Dynamic Worker
@@ -1263,7 +1498,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1188
+
+Private
shall Execute Task
+
+shall Execute Task ( workerNodeKey ) : boolean
+
+
+Returns boolean
Private
shall Update Task Function Worker Usage
@@ -1283,28 +1531,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:935
Private
tasks Queue Size
@@ -1317,20 +1556,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:648
Private
update Elu Worker Usage
@@ -1345,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
update Run Time Worker Usage
@@ -1360,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1104
Private
update Task Statistics Worker Usage
@@ -1375,7 +1617,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1086
+
+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 +1647,28 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
+poolifier - v3.0.1
+
-
\ 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