X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=7d6dbf120f347c20c07663de7b527bfb43e90a08;hb=1ab50fe5ad0b27a13a48047f9414d4138d43a5cd;hp=18268c8c12f8b700b51b2d33c01ebe0d4473b7e6;hpb=2946f23da560702e3f3631887e1eeb88777bd47d;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 18268c8c..7d6dbf12 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -24,9 +24,9 @@
2.0.0
-Protected
workerReadonly
workerProtected
fullWhether the pool is full or not.
The pool filling boolean status.
Private
numberProtected
maxNumber of tasks queued in the pool.
+Pool maximum size.
Private
numberProtected
minNumber of tasks running in the pool.
+Pool minimum size.
Protected
typePool type.
If it is 'dynamic'
, it provides the max
property.
Protected
workerGets the worker type.
+Overrides AbstractPool.worker
+The worker.
The received message.
Inherited from AbstractPool.afterTaskExecutionHook
Protected
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeInherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
The worker node key
+Inherited from AbstractPool.chooseWorkerNode
Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+Inherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Protected
destroyOverrides AbstractPool.destroyWorker
Inherited from AbstractPool.enableTasksQueue
Executes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+Executes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Promise that will be fulfilled when the task is completed.
+Inherited from AbstractPool.execute
Protected
internalInherited from AbstractPool.internalBusy
Protected
isOverrides AbstractPool.isMain
Protected
registerRegisters a listener callback on the given worker.
Overrides AbstractPool.registerWorkerMessageListener
Protected
sendThe worker which should receive the message.
The message.
Overrides AbstractPool.sendToWorker
Inherited from AbstractPool.setTasksQueueOptions
The worker choice strategy.
Inherited from AbstractPool.setWorkerChoiceStrategy
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupOverrides AbstractPool.setupHook
Protected
workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+Inherited from AbstractPool.workerListener
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
@@ -44,7 +44,7 @@@@ -57,9 +57,9 @@
emitter?
-file Path
-number Of Workers
-opts
+file Path
+number Of Workers
+opts
promise Response Map
worker Choice Strategy Context
worker Nodes
@@ -67,10 +67,12 @@
busy
-full
-number Of Queued Tasks
-number Of Running Tasks
-type
+full
+info
+max Size
+min Size
+type
+worker
-
-
+
+ - Defined in src/pools/cluster/fixed.ts:54
@@ -139,35 +141,37 @@
+
+
-
-- Defined in src/pools/abstract-pool.ts:47
+
+ Path
file Path: string
-
-- Defined in src/pools/abstract-pool.ts:82
+
+ Of Workers
number Of Workers: number
-
-- Defined in src/pools/abstract-pool.ts:81
+
+
opts: ClusterPoolOptions = {}
+- Defined in src/pools/cluster/fixed.ts:57
Properties
Accessors
Methods
@@ -103,9 +105,9 @@Constructs a new poolifier fixed cluster pool.
Type Parameters
-+-
-
@@ -128,7 +130,7 @@
Data = unknown
Returns FixedClusterPool<Data, Response>
Properties
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task. Path
+Readonly
fileProtected
Readonly
filePath to the worker file.
Of Workers
+Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
+Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
Protected
promise