X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f0527fbc8a7d21c31668e49f1bf478e704199743;hb=HEAD;hp=92d33f8c78905248290b9bb99ce81ef9e485c8d2;hpb=d93988cdbc3eb55747301602bfa03d8543223c71;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 92d33f8c..5a733a3f 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,1145 +1,159 @@ -
Type of data sent to the worker. This can only be structured-cloneable 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.
-Optional
emitterEvent emitter integrated with async resource on which events can be listened to. +
A cluster pool with a fixed number of workers.
+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.
+Optional
maximumNumberOfWorkers: numberThe maximum number of workers for this pool.
+Optional
emitterPool event emitter integrated with async resource.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
'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 concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'empty'
: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
filePath to the worker file.
-Protected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
-Protected
Readonly
numberNumber of workers that this pool should manage.
-Protected
Readonly
optsOptions for this fixed cluster pool.
-Protected
promiseThe task execution response promise map:
+Protected
Readonly
filePath to the worker file.
+Protected
Optional
Readonly
maximumMaximum number of workers that this pool manages.
+Protected
Readonly
minimumMinimum number of workers that this pool manages.
+Protected
Readonly
optsOptions for the pool.
+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.value
: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Readonly
Internal
workerPool worker nodes.
-Protected
busyWhether the pool is busy or not.
-The pool busyness boolean status.
-Protected
fullWhether the pool is full or not.
-The pool filling boolean status.
-Protected
maxThe pool maximum size.
-Protected
minThe pool minimum size.
-Private
readyThe pool readiness boolean status.
-Protected
typeThe pool type.
-If it is 'dynamic'
, it provides the max
property.
Private
utilizationThe approximate pool utilization.
-The pool utilization.
- -Protected
workerThe worker type.
-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.
Protected
afterProtected
Optional
workerWorker choice strategies context referencing worker choice algorithms implementation.
+Readonly
Internal
workerPool worker nodes.
+Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Protected
emptyWhether the pool is empty or not.
+The pool emptiness boolean status.
+Protected
fullWhether the pool is full or not.
+The pool fullness boolean status.
+Protected
typeThe pool type.
+If it is 'dynamic'
, it provides the max
property.
Protected
workerThe worker type.
+The name of the task function.
+The task function.
+true
if the task function was added, false
otherwise.
Protected
afterHook executed after the worker task execution. Can be overridden.
-The worker node key.
-The received message.
-Protected
afterMethod hooked up after a worker node has been newly created. +
The worker node key.
+The received message.
+Protected
afterProtected
beforeProtected
beforeHook executed before the worker task execution. Can be overridden.
-The worker node key.
-The task to execute.
-Protected
createProtected
createProtected
createProtected
deregisterDeregisters a listener callback on the worker given its worker node key.
-The worker node key.
-The message listener callback.
-Protected
destroyEnables/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.
-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.
- -Protected
flushProtected
getGets the worker information given its worker node key.
-The worker node key.
-The worker information.
- -Protected
internalProtected
isProtected
registerRegisters once a listener callback on the worker given its worker node key.
-The worker node key.
-The message listener callback.
-Protected
registerRegisters a listener callback on the worker given its worker node key.
-The worker node key.
-The message listener callback.
-Protected
sendProtected
sendProtected
sendSends a message to worker given its worker node key.
-The worker node key.
-The message.
-Sets the worker node tasks queue options in this pool.
-The worker node tasks queue options.
-Sets the worker choice strategy in this pool.
-The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Sets the worker choice strategy options in this pool.
-The worker choice strategy options.
-Protected
setupProtected
checkProtected
createProtected
createProtected
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
destroyOptional
tasksQueueOptions: TasksQueueOptionsOptional
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: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise with a task function response that will be fulfilled when the task is completed.
+Protected
flagProtected
flushProtected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+Protected
internalProtected
isThe properties of task functions available in this pool.
+The tasks iterable input data for the specified task function. This can only be an iterable of 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: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise with an array of task function responses that will be fulfilled when the tasks are completed.
+Protected
registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
sendProtected
sendSends a message to worker given its worker node key.
+The worker node key.
+The message.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+true
if the worker choice strategy options were set, false
otherwise.
Protected
setupProtected
workerThis method 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.
-The listener function to execute when a message is received from a worker.
- -Generated using TypeDoc
Protected
shallProtected
Readonly
workerThis method is the message listener registered on each worker.
+The message received from the worker.
+
A cluster pool with a fixed number of workers.
-Author
Christopher Quadflieg
- -Since
2.0.0
-