X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicClusterPool.html;h=17b4b9e076d2b55bc646157ea2be7504f4116b1f;hb=224d008191f52fa20b93e1ba67919569f8d6e315;hp=f0e6f7d7ee06b142854113feaf20eb9076d6fe51;hpb=e1ba9765afbf97436250d19f28c818221ebc10b9;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index f0e6f7d7..17b4b9e0 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,26 +1,24 @@ -
Protected
beforeProtected
checkProtected
createProtected
checkProtected
createProtected
createCreates a new, completely set up worker node.
+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.
+The message listener callback.
+Protected
destroyOptional
tasksQueueOptions: TasksQueueOptionsProtected
flagProtected
flushProtected
getGets the worker information given its worker node key.
+Optional
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
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Protected
internalProtected
isProtected
registerRegisters once a listener callback on the worker given its worker node key.
+Protected
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 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
sendSends the startup message to worker given its 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.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsProtected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+true
if the worker choice strategy options were set, false
otherwise.
Protected
setupProtected
shallProtected
shallProtected
Readonly
workerThis method is the message listener registered on each worker.
-Generated using TypeDoc
Protected
Readonly
workerThis method is the message listener registered on each worker.
+The message received from the worker.
+
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.15Class DynamicClusterPool<Data, Response>
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
.Author
Christopher Quadflieg
-Since
2.0.0
+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'semitter
. +Author
Christopher Quadflieg
+Since
2.0.0
Type Parameters
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.
-Hierarchy (view full)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new poolifier dynamic cluster pool.
+Constructors
constructor
Constructs a new poolifier dynamic cluster pool.
Type Parameters
Parameters
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.
-Returns DynamicClusterPool<Data, Response>
Properties
Optional
emitterPool event emitter integrated with async resource. +
Returns DynamicClusterPool<Data, Response>
Properties
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. 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).'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
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:
+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
Optional
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Readonly
Internal
workerPool worker nodes.
-Accessors
Protected
busyWhether the pool is busy or not.
-The pool busyness boolean status.
-Returns boolean
Protected
emptyThe pool emptiness boolean status.
-Returns boolean
Protected
fullWhether the pool is full or not.
-The pool filling boolean status.
-Returns boolean
info
Pool information.
-Returns PoolInfo
Private
readyThe pool readiness boolean status.
-Returns boolean
Protected
typeThe pool type.
-If it is
-'dynamic'
, it provides themax
property.Returns "fixed" | "dynamic"
Private
utilizationThe approximate pool utilization.
-Returns number
The pool utilization.
-Protected
workerThe worker type.
-Returns "thread" | "cluster"
Methods
add Task Function
Parameters
Returns Promise<boolean>
Inherit Doc
Protected
afterHook executed after the worker task execution. +
Protected
Optional
workerWorker choice strategies context referencing worker choice algorithms implementation.
+Readonly
Internal
workerPool worker nodes.
+Accessors
Protected
busyWhether the pool is busy or not.
+Returns boolean
The pool busyness boolean status.
+Protected
emptyWhether the pool is empty or not.
+Returns boolean
The pool emptiness boolean status.
+Protected
fullWhether the pool is full or not.
+Returns boolean
The pool fullness boolean status.
+info
Pool information.
+Returns PoolInfo
Protected
typeThe pool type.
+If it is
+'dynamic'
, it provides themax
property.Returns "fixed" | "dynamic"
Protected
workerThe worker type.
+Returns "thread" | "cluster"
Methods
add Task Function
Parameters
The name of the task function.
+The task function.
+Returns Promise<boolean>
+true
if the task function was added,false
otherwise.Protected
afterHook executed after the worker task execution. Can be overridden.
Parameters
The worker node key.
The received message.
-Returns void
Protected
afterMethod hooked up after a worker node has been newly created. +
Returns void
Protected
afterMethod hooked up after a worker node has been newly created. Can be overridden.
Parameters
The newly created worker node key.
-Returns void
Protected
beforeHook executed before the worker task execution. +
Returns void