X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=15f01272545e185515b0038899441c4f564cdfe6;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=dd35f98d01c694769753bcbb34b308f4498ce8dc;hpb=2624da4d8f724e8bc0b655cddfc6ba5ae9a4d053;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index dd35f98d..15f01272 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 +160,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 +247,7 @@
info
@@ -253,7 +259,7 @@
Protected
max@@ -265,7 +271,7 @@
Protected
min@@ -277,20 +283,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 +305,7 @@
Overrides AbstractPool.type
-- Defined in src/pools/cluster/fixed.ts:87
Private
utilization@@ -316,7 +318,7 @@
Inherited from AbstractPool.utilization
-- Defined in src/pools/abstract-pool.ts:315
Protected
worker@@ -328,7 +330,7 @@
Overrides AbstractPool.worker
-- Defined in src/pools/cluster/fixed.ts:92
Methods
Inherited from AbstractPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:558
Protected
after@@ -377,7 +379,7 @@ Can be overridden.
Inherited from AbstractPool.afterWorkerSetup
-- Defined in src/pools/abstract-pool.ts:750
Protected
before@@ -403,7 +405,23 @@ Can be overridden.
Inherited from AbstractPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:542
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:174
Protected
create@@ -416,7 +434,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupDynamicWorker
-- Defined in src/pools/abstract-pool.ts:793
Protected
create@@ -429,7 +447,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:760
Protected
create@@ -442,7 +460,7 @@ Can be overridden.
Overrides AbstractPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:82
destroy
@@ -454,7 +472,7 @@ Can be overridden.
Inherited from AbstractPool.destroy
-- Defined in src/pools/abstract-pool.ts:503
Protected
destroy@@ -474,7 +492,7 @@ Can be overridden.
Overrides AbstractPool.destroyWorker
-- Defined in src/pools/cluster/fixed.ts:68
enable Tasks Queue
@@ -499,7 +517,7 @@ Can be overridden.
Inherited from AbstractPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:409
execute
@@ -525,7 +543,51 @@ Can be overridden.
Inherited from AbstractPool.execute
-- Defined in src/pools/abstract-pool.ts:469
Worker Info By Worker
+Protected
get+- get
Worker Info By Worker(worker): WorkerInfo
+-
+
+
+
+
+
+
Gets the worker information from the given worker.
+Parameters
++-
+
+
worker: Worker
+The worker.
+Returns WorkerInfo
The worker information.
+ +Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+Inherited from AbstractPool.getWorkerInfoByWorker
++- Defined in src/pools/abstract-pool.ts:1067
Worker Node Key
+Protected
get+- get
Worker Node Key(worker): number
+-
+
+
+
+
+
Gets the given worker its worker node key.
+Parameters
++-
+
+
worker: Worker
+The worker.
+Returns number
The worker node key if found in the pool worker nodes,
+ +-1
otherwise.Inherited from AbstractPool.getWorkerNodeKey
++- Defined in src/pools/abstract-pool.ts:519
Protected
internal@@ -538,7 +600,7 @@ Can be overridden.
Inherited from AbstractPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:460
Protected
is@@ -550,7 +612,68 @@ Can be overridden.
Overrides AbstractPool.isMain
-- Defined in src/pools/cluster/fixed.ts:63
Worker Message Listener
+Protected
register+- register
Worker Message Listener<Message>(worker, listener): void
+-
+
+
+
+
+
+
+
Registers a listener callback on the given worker.
+Type Parameters
++-
+
Message
Parameters
++-
+
+
+-
+
+
+
worker: Worker
+The worker which should register a listener.
+listener: ((message) => void)
+The message listener callback.
++-
+
+- (message): void
+-
+
+
+
Parameters
++-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+Overrides AbstractPool.registerWorkerMessageListener
++- Defined in src/pools/cluster/fixed.ts:85
Startup Message To Worker
+Protected
send+- send
Startup Message To Worker(worker): void
+-
+
+
+
+
+
Sends the startup message to the given worker.
+Parameters
++-
+
+
worker: Worker
+The worker which should receive the startup message.
+Returns void
+Overrides AbstractPool.sendStartupMessageToWorker
++- Defined in src/pools/cluster/fixed.ts:77
Protected
send@@ -575,7 +698,7 @@ Can be overridden.
Overrides AbstractPool.sendToWorker
-- Defined in src/pools/cluster/fixed.ts:77
set Tasks Queue Options
@@ -595,7 +718,7 @@ Can be overridden.
Inherited from AbstractPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:421
set Worker Choice Strategy
@@ -620,7 +743,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:376
set Worker Choice Strategy Options
@@ -640,7 +763,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:398
Protected
setup@@ -653,7 +776,7 @@ Can be overridden.
Overrides AbstractPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:58
Protected
worker@@ -681,7 +804,7 @@ Can be overridden.
Inherited from AbstractPool.workerListener
-- Defined in src/pools/abstract-pool.ts:818