X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=b0b08b596590cc7b60e3d403ac17d94f4081dbcd;hb=47c9cec4c0a1a871153e1811ec6d95c90d2c86d1;hp=b00d1c78b4e76effc3ad44b4415be91947e3444d;hpb=2a6631992868d900762f62e4c228dce4e4ee549a;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index b00d1c78..b0b08b59 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 +157,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 maximum 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 +244,7 @@
info
@@ -253,7 +256,7 @@
Protected
max@@ -265,7 +268,7 @@
Protected
min@@ -277,20 +280,25 @@
Time
+Private
runPrivate
ready-- get runTime(): number
+- get ready(): boolean
-
-
-
Gets the pool run time.
-Returns number
The pool run time in milliseconds.
- -
+Private
starting+- get starting(): boolean
+-
+
+
Returns boolean
Inherited from AbstractPool.starting
++- Defined in src/pools/abstract-pool.ts:402
Protected
type@@ -303,7 +311,7 @@
Overrides AbstractPool.type
-- Defined in src/pools/cluster/fixed.ts:87
Private
utilization@@ -316,7 +324,7 @@
Inherited from AbstractPool.utilization
-- Defined in src/pools/abstract-pool.ts:312
Protected
worker@@ -328,7 +336,7 @@
Overrides AbstractPool.worker
-- Defined in src/pools/cluster/fixed.ts:92
Methods
Inherited from AbstractPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:555
Protected
after@@ -377,7 +385,7 @@ Can be overridden.
Inherited from AbstractPool.afterWorkerSetup
-- Defined in src/pools/abstract-pool.ts:747
Protected
before@@ -403,7 +411,23 @@ Can be overridden.
Inherited from AbstractPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:539
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:160
Protected
create@@ -416,7 +440,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupDynamicWorker
-- Defined in src/pools/abstract-pool.ts:790
Protected
create@@ -429,7 +453,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:757
Protected
create@@ -442,7 +466,7 @@ Can be overridden.
Overrides AbstractPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:82
destroy
@@ -454,7 +478,7 @@ Can be overridden.
Inherited from AbstractPool.destroy
-- Defined in src/pools/abstract-pool.ts:500
Protected
destroy@@ -474,7 +498,7 @@ Can be overridden.
Overrides AbstractPool.destroyWorker
-- Defined in src/pools/cluster/fixed.ts:68
enable Tasks Queue
@@ -499,7 +523,7 @@ Can be overridden.
Inherited from AbstractPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:406
execute
@@ -525,7 +549,7 @@ Can be overridden.
Inherited from AbstractPool.execute
-- Defined in src/pools/abstract-pool.ts:466
Protected
internal@@ -538,7 +562,7 @@ Can be overridden.
Inherited from AbstractPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:457
Protected
is@@ -550,7 +574,7 @@ Can be overridden.
Overrides AbstractPool.isMain
-- Defined in src/pools/cluster/fixed.ts:63
Protected
send@@ -575,7 +599,7 @@ Can be overridden.
Overrides AbstractPool.sendToWorker
-- Defined in src/pools/cluster/fixed.ts:77
set Tasks Queue Options
@@ -595,7 +619,7 @@ Can be overridden.
Inherited from AbstractPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:418
set Worker Choice Strategy
@@ -620,7 +644,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:373
set Worker Choice Strategy Options
@@ -640,7 +664,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:395
Protected
setup@@ -653,7 +677,7 @@ Can be overridden.
Overrides AbstractPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:58
Protected
worker@@ -681,7 +705,7 @@ Can be overridden.
Inherited from AbstractPool.workerListener
-- Defined in src/pools/abstract-pool.ts:815