X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=178283008215f35e2fc087b357aaf3565ee49def;hb=896624ae5d3cb6861b202a4c3b1d4c42368868c5;hp=f1ef3db14bdc96078f93ca2674d9813e6d0c81bb;hpb=cd3135e48c6ba3fb7bdfe3da9ac47ad6805e8797;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index f1ef3db1..17828300 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -3,7 +3,7 @@
2.0.0
Type of execution response. This can only be structured-cloneable data.
-Constructs a new poolifier fixed cluster pool.
+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. +
Optional
emitterEvent emitter integrated with async resource on which events can be listened to.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
poolifier:<PoolType>-<Wo
'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
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:
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.
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Readonly
Internal
workerPool worker nodes.
-Protected
busyWhether the pool is busy or not.
+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.
+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.
+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.
+Private
utilizationThe approximate pool utilization.
The pool utilization.
-Protected
workerThe worker type.
-Adds a task function to this pool. +
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
afterHook executed after the worker task execution. Can be overridden.
The worker node key.
The received message.
-Protected
afterProtected
afterProtected
beforeProtected
beforeHook executed before the worker task execution. Can be overridden.
The worker node key.
The task to execute.
-Protected
createProtected
createProtected
createCreates a new, completely set up worker node.
+Protected
createProtected
createCreates a new worker.
+Protected
createProtected
deregisterDeregisters a listener callback on the worker given its worker node key.
+Protected
deregisterDeregisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
-Protected
destroyTerminates the worker node given its worker node key.
+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 chosen 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
flagProtected
flushProtected
getGets the worker information given its worker node key.
+Protected
flagProtected
flushProtected
getGets the worker information given its worker node key.
The worker node key.
The worker information.
-Whether the specified task function exists in this pool.
+Internal
Whether the worker node has back pressure (i.e. its tasks queue is full).
+Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Protected
internalProtected
isLists the names of task function available in this pool.
+Protected
isProtected
registerRegisters once a listener callback on the worker given its worker node key.
+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.
+Protected
registerRegisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
-Removes a task function from this pool.
+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.
+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
setupProtected
workerThis method is the message listener registered on each worker.
-Generated using TypeDoc
Type of data sent to the worker. This can only be structured-cloneable data.