ProtectedbeforeProtected checkProtected createProtectedcheckProtectedcreateProtected createCreates a new, completely set up worker node.
+ProtectedcreateProtected deregisterDeregisters a listener callback on the worker given its worker node key.
+ProtectedderegisterDeregisters 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.
+ProtecteddestroyOptional tasksQueueOptions: TasksQueueOptionsProtected flagProtected flushProtected getGets the worker information given its worker node key.
+OptionaltasksQueueOptions: TasksQueueOptionsOptionaldata: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+OptionaltransferList: 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.
+ProtectedflagProtectedflushProtectedgetGets 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.
+ProtectedinternalProtected isReturns whether the worker is the main worker or not.
+ProtectedisProtected 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.
+Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+OptionaltransferList: 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.
+ProtectedregisterRegisters 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.
+ProtectedregisterRegisters 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.
+ProtectedsendProtected sendProtectedsendSends a message to worker given its worker node key.
The worker node key.
The message.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsProtected setupOptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+true if the worker choice strategy options were set, false otherwise.
ProtectedsetupProtected shallProtectedshallProtected Readonly workerThis method is the message listener registered on each worker.
-Protected ReadonlyworkerThis 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.0.18Class 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
ClusterWorkerfile, which can be relative or absolute.Options for this fixed cluster pool.
-OptionalmaximumNumberOfWorkers: numberReturns FixedClusterPool<Data, Response>
Properties
OptionalemitterPool event emitter integrated with async resource. +
OptionalmaximumNumberOfWorkers: numberThe maximum number of workers for this pool.
+Returns FixedClusterPool<Data, Response>
Properties
OptionalemitterPool 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).ProtectedReadonlyfilePath to the worker file.
-ProtectedOptionalReadonlymaximumMaximum number of workers that this pool manages.
-ProtectedReadonlyminimumMinimum number of workers that this pool manages.
-ProtectedReadonlyoptsOptions for the pool.
-ProtectedpromiseThe task execution response promise map:
+ProtectedReadonlyfilePath to the worker file.
+ProtectedOptionalReadonlymaximumMaximum number of workers that this pool manages.
+ProtectedReadonlyminimumMinimum number of workers that this pool manages.
+ProtectedReadonlyoptsOptions for the pool.
+ProtectedpromiseThe 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.
-ProtectedOptionalworkerWorker choice strategies context referencing worker choice algorithms implementation.
-ReadonlyInternalworkerPool worker nodes.
-Accessors
ProtectedbusyWhether the pool is busy or not.
-The pool busyness boolean status.
-Returns boolean
ProtectedemptyThe pool emptiness boolean status.
-Returns boolean
ProtectedfullWhether the pool is full or not.
-The pool filling boolean status.
-Returns boolean
info
Pool information.
-Returns PoolInfo
PrivatereadyThe pool readiness boolean status.
-Returns boolean
ProtectedtypeThe pool type.
-If it is
-'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
PrivateutilizationThe approximate pool utilization.
-Returns number
The pool utilization.
-ProtectedworkerThe worker type.
-Returns "thread" | "cluster"
Methods
add
Parameters
Returns Promise<boolean>
Inherit Doc
ProtectedafterHook executed after the worker task execution. +
ProtectedOptionalworkerWorker choice strategies context referencing worker choice algorithms implementation.
+ReadonlyInternalworkerPool worker nodes.
+Accessors
ProtectedbusyWhether the pool is busy or not.
+Returns boolean
The pool busyness boolean status.
+ProtectedemptyWhether the pool is empty or not.
+Returns boolean
The pool emptiness boolean status.
+ProtectedfullWhether the pool is full or not.
+Returns boolean
The pool fullness boolean status.
+info
Pool information.
+Returns PoolInfo
ProtectedtypeThe pool type.
+If it is
+'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
ProtectedworkerThe worker type.
+Returns "thread" | "cluster"
Methods
add
Parameters
The name of the task function.
+The task function.
+Returns Promise<boolean>
+trueif the task function was added,falseotherwise.ProtectedafterHook executed after the worker task execution. Can be overridden.
Parameters
The worker node key.
The received message.
-Returns void
ProtectedafterMethod hooked up after a worker node has been newly created. +
Returns void
ProtectedafterMethod hooked up after a worker node has been newly created. Can be overridden.
Parameters
The newly created worker node key.
-Returns void
ProtectedbeforeHook executed before the worker task execution. +
Returns void