X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f4d30b5b8789b1620e454f5dc2c9fa2007dfec3a;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=34eaa0cd20bf308e57c087cf216bd6a77bf5c1b6;hpb=5497d426557f576e3ee314619f83b71685acc6bc;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 34eaa0cd..f4d30b5b 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -154,7 +156,7 @@ +'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
worker Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -241,7 +243,7 @@
info
@@ -253,7 +255,7 @@
Protected
max@@ -265,7 +267,7 @@
Protected
min@@ -277,20 +279,16 @@
Time
+Private
runPrivate
ready-- get runTime(): number
+- get ready(): boolean
-
-
-
Gets the pool run time.
-Returns number
The pool run time in milliseconds.
- -Protected
type@@ -303,7 +301,7 @@
Overrides AbstractPool.type
-- Defined in src/pools/cluster/fixed.ts:87
Private
utilization@@ -316,7 +314,7 @@
Inherited from AbstractPool.utilization
-- Defined in src/pools/abstract-pool.ts:317
Protected
worker@@ -328,7 +326,7 @@
Overrides AbstractPool.worker
-- Defined in src/pools/cluster/fixed.ts:92
Methods
Inherited from AbstractPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:566
Protected
after@@ -377,7 +375,7 @@ Can be overridden.
Inherited from AbstractPool.afterWorkerSetup
-- Defined in src/pools/abstract-pool.ts:758
Protected
before@@ -403,7 +401,23 @@ Can be overridden.
Inherited from AbstractPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:550
Dynamic Pool Size
+Protected
check+- check
Dynamic Pool Size(min, max): void
+-
+
+
+
+
Parameters
++-
+
+-
+
min: number
max: number
Returns void
Inherited from AbstractPool.checkDynamicPoolSize
++- Defined in src/pools/abstract-pool.ts:181
Protected
create@@ -416,7 +430,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupDynamicWorker
-- Defined in src/pools/abstract-pool.ts:828
Protected
create@@ -429,7 +443,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:768
Protected
create@@ -442,7 +456,7 @@ Can be overridden.
Overrides AbstractPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:82
destroy
@@ -454,7 +468,7 @@ Can be overridden.
Inherited from AbstractPool.destroy
-- Defined in src/pools/abstract-pool.ts:505
Protected
destroy@@ -474,7 +488,7 @@ Can be overridden.
Overrides AbstractPool.destroyWorker
-- Defined in src/pools/cluster/fixed.ts:68
enable Tasks Queue
@@ -499,7 +513,7 @@ Can be overridden.
Inherited from AbstractPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:411
execute
@@ -525,7 +539,7 @@ Can be overridden.
Inherited from AbstractPool.execute
-- Defined in src/pools/abstract-pool.ts:471
Protected
internal@@ -538,7 +552,7 @@ Can be overridden.
Inherited from AbstractPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:462
Protected
is@@ -550,7 +564,7 @@ Can be overridden.
Overrides AbstractPool.isMain
-- Defined in src/pools/cluster/fixed.ts:63
Protected
send@@ -575,7 +589,7 @@ Can be overridden.
Overrides AbstractPool.sendToWorker
-- Defined in src/pools/cluster/fixed.ts:77
set Tasks Queue Options
@@ -595,7 +609,7 @@ Can be overridden.
Inherited from AbstractPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:423
set Worker Choice Strategy
@@ -620,7 +634,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:378
set Worker Choice Strategy Options
@@ -640,7 +654,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:400
Protected
setup@@ -653,7 +667,7 @@ Can be overridden.
Overrides AbstractPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:58
Protected
worker@@ -681,7 +695,7 @@ Can be overridden.
Inherited from AbstractPool.workerListener
-- Defined in src/pools/abstract-pool.ts:853