X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=4bdb14c01f1a94bc0a9d701fb445676225955730;hb=05a852b826fb54cbab49a196bbd0d123c3d0c367;hp=7ce5b2fb4e450665b33c030d6cc8663614c0888b;hpb=396360a789e4806699533ddf899c79dc2b7ae868;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 7ce5b2fb..4bdb14c0 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,703 +1,140 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of execution response. This can only be serializable 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
Readonly
emitterEmitter 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: numberOptional
emitterPool event emitter integrated with async resource.
+The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'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).Readonly
filePath to the worker file.
-Readonly
numberNumber of workers that this pool should manage.
-Readonly
optsOptions for this fixed cluster pool.
-Protected
promiseThe 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.
-Default to a round robin algorithm.
-Readonly
workerPool worker nodes.
-Protected
busyWhether the pool is busy or not.
+Protected
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
fullWhether the pool is full or not.
+Protected
emptyThe pool emptiness boolean status.
+Protected
fullWhether the pool is full or not.
The pool filling boolean status.
-Private
numberNumber of tasks queued in the pool.
-Private
numberNumber of tasks running in the pool.
-Pool type.
+Private
readyThe pool readiness boolean status.
+Protected
typeThe pool type.
If it is 'dynamic'
, it provides the max
property.
Protected
afterPrivate
utilizationThe approximate pool utilization.
+The pool utilization.
+Protected
workerThe worker type.
+Protected
afterHook executed after the worker task execution. Can be overridden.
-The worker.
-The received message.
-Protected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
The newly created worker.
-Protected
beforeHook executed before the worker task execution. +
The worker node key.
+The received message.
+Protected
afterProtected
chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
-[worker node key, worker node].
-Protected
createProtected
createProtected
destroyEnables/disables the worker tasks queue in this pool.
-Whether to enable or disable the worker tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Executes the function specified 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.
-Promise that will be fulfilled when the task is completed.
-Protected
internalProtected
isProtected
registerRegisters a listener callback on the given worker.
-The worker which should register a listener.
-The message listener callback.
-Protected
sendSends a message to the given worker.
-The worker which should receive the message.
-The message.
-Sets the worker tasks queue options in this pool.
-The worker 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
workerThis function 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.
-Generated using TypeDoc
The newly created worker node key.
+Protected
beforeProtected
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: TasksQueueOptionsProtected
flagProtected
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
sendSends a message to worker given its worker node key.
+The worker node key.
+The message.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsProtected
setupProtected
shallProtected
Readonly
workerThis method is the message listener registered on each worker.
+
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
- -Since
2.0.0
-