X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=2c08b7ebb719b05ee671cb3e58b23748cf6137a1;hb=76369162548ededf89e0d513174a943cc330245c;hp=e2e7da263b2e264ccf64dbf2fd63d77edcfb8cb1;hpb=4736ba628fabbf7e34e36ef0f55a96e86b7033ac;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index e2e7da26..2c08b7eb 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,15 +1,15 @@ -
Constructs a new poolifier dynamic cluster pool.
Minimum number of workers which are always active.
-Maximum number of workers that can be created by this pool.
-Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this dynamic cluster pool.
-Optional
Readonly
emitterProtected
Readonly
maxMaximum number of workers that can be created by this pool.
-Inherited from FixedClusterPool.max
Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from FixedClusterPool.numberOfWorkers
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from FixedClusterPool.opts
Protected
promiseThe promise response map.
+Protected
promiseThe task execution response promise map:
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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.
-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 FixedClusterPool.promiseResponseMap
Protected
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workersInherited from FixedClusterPool.workers
+Readonly
Internal
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedClusterPool.busy
Protected
fullOverrides FixedClusterPool.full
+Whether the pool is full or not.
+The pool filling boolean status.
+Inherited from FixedClusterPool.full
Private
numberNumber of tasks concurrently running in the pool.
+Pool information.
Inherited from FixedClusterPool.numberOfRunningTasks
+Inherited from FixedClusterPool.info
Protected
maxThe pool maximum size.
+Inherited from FixedClusterPool.maxSize
+Protected
minThe pool minimum size.
+Inherited from FixedClusterPool.minSize
+Private
readyThe pool readiness boolean status.
+Inherited from FixedClusterPool.ready
+Protected
typeThe pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Inherited from FixedClusterPool.utilization
+Protected
workerThe worker type.
+Inherited from FixedClusterPool.worker
+Protected
afterHook executed after the worker task promise resolution. +
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true
if the task function was added, false
otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Inherited from FixedClusterPool.addTaskFunction
+Protected
afterHook executed after the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The received message.
-Inherited from FixedClusterPool.afterPromiseResponseHook
+Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
afterProtected
afterMethod hooked up after a worker node has been newly created. +Can be overridden.
+Inherited from FixedClusterPool.afterWorkerSetup
+The newly created worker node key.
+Inherited from FixedClusterPool.afterWorkerNodeSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker key.
-Inherited from FixedClusterPool.beforePromiseResponseHook
+The worker node key.
+The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseProtected
createChooses a worker for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker key, worker].
+Creates a new, completely set up dynamic worker node.
Inherited from FixedClusterPool.chooseWorker
+New, completely set up dynamic worker node key.
+ +Inherited from FixedClusterPool.createAndSetupDynamicWorkerNode
Protected
createProtected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Creates a new, completely set up worker node.
Inherited from FixedClusterPool.createAndSetupWorker
+New, completely set up worker node key.
+ +Inherited from FixedClusterPool.createAndSetupWorkerNode
Protected
createProtected
createCreates a new worker.
+Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
Protected
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.deregisterWorkerMessageListener
+Terminates all workers in this pool.
+Inherited from FixedClusterPool.destroy
Protected
destroyTerminates the worker node given its worker node key.
+Inherited from FixedClusterPool.destroyWorker
+The worker node key.
+Inherited from FixedClusterPool.destroyWorkerNode
Enables/disables the worker node tasks queue in this pool.
+Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+Executes the specified function in the worker constructor with the task data input parameter.
+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 FixedClusterPool.execute
Protected
flagInherited from FixedClusterPool.findFreeWorkerKey
+Inherited from FixedClusterPool.flagWorkerNodeAsNotReady
+Protected
flushInherited from FixedClusterPool.flushTasksQueue
Protected
internalProtected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Inherited from FixedClusterPool.getWorkerInfo
+Whether the specified task function exists in this pool.
+The name of the task function.
+true
if the task function exists, false
otherwise.
Inherited from FixedClusterPool.hasTaskFunction
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+The worker node key.
+true
if the worker node has back pressure, false
otherwise.
Inherited from FixedClusterPool.hasWorkerNodeBackPressure
+Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from FixedClusterPool.internalBusy
Protected
isProtected
isShould return whether the worker is the main worker or not.
+Inherited from FixedClusterPool.isMain
Lists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from FixedClusterPool.listTaskFunctionNames
+Protected
registerThe worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.registerOnceWorkerMessageListener
+Protected
registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
+Removes a task function from this pool.
The worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
+The name of the task function.
+true
if the task function was removed, false
otherwise.
Inherited from FixedClusterPool.removeTaskFunction
Protected
sendProtected
sendInherited from FixedClusterPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Inherited from FixedClusterPool.sendStartupMessageToWorker
+Protected
sendSends a message to worker given its worker node key.
+The worker node key.
+The message.
+Inherited from FixedClusterPool.sendToWorker
Sets the default task function in this pool.
+The name of the task function.
+true
if the default task function was set, false
otherwise.
Inherited from FixedClusterPool.setDefaultTaskFunction
+Sets the worker node tasks queue options in this pool.
+The worker node tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setupSets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
+Inherited from FixedClusterPool.setupHook
Protected
workerThis function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+Starts the minimum number of workers in this pool.
Inherited from FixedClusterPool.start
+Protected
workerThis function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+This method is the message listener registered on each worker.
Inherited from FixedClusterPool.workerListener
+Inherited from FixedClusterPool.workerMessageListener
Generated using TypeDoc
Generated using TypeDoc
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
+emitter
.