X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=cda595b96829af9956ada0e732844666d8f47a25;hb=1d9f69fa27366fd18f2600beeee89187306df22a;hp=5680e5ebfe5a5f3f34f1986a3d652760e6915f1d;hpb=bb3f9b66fa2241864d31937eeced22caab83d17e;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 5680e5eb..d4dc6e76 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Constructs a new poolifier fixed cluster pool.
Number of workers for this pool.
-Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this fixed cluster pool.
-Overrides AbstractPool<Worker, Data, Response>.constructor
+Overrides AbstractPool.constructor
Optional
Readonly
emitterInherited from AbstractPool.emitter
-Readonly
filePath to the worker-file.
-Inherited from AbstractPool.filePath
-Readonly
numberOptional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'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.Inherited from AbstractPool.emitter
+Protected
Readonly
filePath to the worker file.
+Inherited from AbstractPool.filePath
+Protected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from AbstractPool.numberOfWorkers
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from AbstractPool.opts
+ +Inherited from AbstractPool.opts
Protected
promiseThe execution response promise map.
+Protected
promiseThe task execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-Inherited from AbstractPool.promiseResponseMap
+Inherited from AbstractPool.promiseResponseMap
Protected
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from AbstractPool.workerChoiceStrategyContext
-Readonly
workerInherited from AbstractPool.workerNodes
+ +Inherited from AbstractPool.workerChoiceStrategyContext
+Readonly
workerPool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullOverrides AbstractPool.full
-Private
numberWhether the pool is full or not.
+The pool filling boolean status.
+Inherited from AbstractPool.full
+Number of tasks queued in the pool.
+Pool information.
Inherited from AbstractPool.numberOfQueuedTasks
-Private
numberInherited from AbstractPool.info
+Protected
maxNumber of tasks running in the pool.
+The pool maximum size.
Inherited from AbstractPool.numberOfRunningTasks
-Overrides AbstractPool.maxSize
+Protected
minThe pool minimum size.
+Overrides AbstractPool.minSize
+Private
readyThe pool readiness boolean status.
+Inherited from AbstractPool.ready
+Protected
typeThe pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Inherited from AbstractPool.utilization
+Protected
workerThe worker type.
+Overrides AbstractPool.worker
+Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -262,37 +348,45 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
-Protected
afterInherited from AbstractPool.afterTaskExecutionHook
+Protected
afterMethod hooked up after a worker node has been newly created. +Can be overridden.
+Overrides AbstractPool.afterWorkerSetup
-Protected
beforeThe newly created worker node key.
+Inherited from AbstractPool.afterWorkerNodeSetup
+Protected
beforeHook executed before the worker task execution. Can be overridden.
@@ -301,237 +395,420 @@ Can be overridden.The worker node key.
-The task to execute.
+Inherited from AbstractPool.beforeTaskExecutionHook
+Protected
checkInherited from AbstractPool.beforeTaskExecutionHook
+Inherited from AbstractPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
+Creates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
-[worker node key, worker node].
+Inherited from AbstractPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
Inherited from AbstractPool.chooseWorkerNode
-Protected
createNew, completely set up worker node key.
+ +Inherited from AbstractPool.createAndSetupWorkerNode
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new worker.
+Newly created worker.
-New, completely set up worker.
+Overrides AbstractPool.createWorker
+Terminates all workers in this pool.
Inherited from AbstractPool.createAndSetupWorker
-Protected
createInherited from AbstractPool.destroy
+Protected
destroyOverrides AbstractPool.createWorker
-Terminates the worker node given its worker node key.
+The worker node key.
+Overrides AbstractPool.destroyWorkerNode
+Inherited from AbstractPool.destroy
-Enables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+Executes the specified function in the worker constructor with the task data input parameter.
+Overrides AbstractPool.destroyWorker
-Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from AbstractPool.execute
+Protected
flushInherited from AbstractPool.flushTasksQueue
Protected
getInherited from AbstractPool.findFreeWorkerNodeKey
-Protected
internalGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Inherited from AbstractPool.getWorkerInfo
+Protected
internalInherited from AbstractPool.internalBusy
-Protected
isWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from AbstractPool.internalBusy
+Protected
isOverrides AbstractPool.isMain
-Should return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Protected
registerThe worker node key.
+The message listener callback.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
sendOverrides AbstractPool.registerWorkerMessageListener
+Protected
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Overrides AbstractPool.sendStartupMessageToWorker
+Protected
sendSends a message to worker given its worker node key.
+The worker node key.
+Overrides AbstractPool.sendToWorker
-The message.
+Overrides AbstractPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Inherited from AbstractPool.setWorkerChoiceStrategy
-Protected
setupInherited from AbstractPool.setTasksQueueOptions
+Overrides AbstractPool.setupHook
-Protected
workerSets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Overrides AbstractPool.setupHook
+Protected
workerThis method is the listener registered for each worker message.
+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.
+This method is the listener registered for each worker message.
Inherited from AbstractPool.workerListener
+The listener function to execute when a message is received from a worker.
+ +Inherited from AbstractPool.workerListener
Generated using TypeDoc
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the workers in a round robin fashion.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0