X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=f0527fbc8a7d21c31668e49f1bf478e704199743;hb=HEAD;hp=12518c5709f8f035be1250c8a6b379c050b5e113;hpb=6c2aa71d06cfeccb07a325f7d9bc5ecdbb42a11f;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 12518c57..5a733a3f 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,9 +1,9 @@ -
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
isReturns whether the worker is the main worker or not.
+Protected
isProtected
registerRegisters once a listener callback on the worker given its worker node key.
+The 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
setupOptional
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.
-Protected
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
+- Preparing search index...
- The search index is not available
poolifier - v4.2.3Class FixedClusterPool<Data, Response>
A cluster pool with a fixed number of workers.
+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
Methods
Constructors
constructor
Constructs a new poolifier fixed cluster pool.
+Constructors
constructor
Constructs a new poolifier fixed cluster pool.
Type Parameters
Parameters
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: numberReturns FixedClusterPool<Data, Response>
Properties
Optional
emitterPool event emitter integrated with async resource. +
Optional
maximumNumberOfWorkers: numberThe maximum number of workers for this pool.
+Returns FixedClusterPool<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 task's worker node key, execution response promise resolve and reject callbacks, async resource.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 strategies context referencing worker choice algorithms 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