Protected 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
Protected Readonly workerThis method is the message listener registered on each worker.
+Generated using TypeDoc
A cluster pool with a fixed number of workers.
+- Preparing search index...
- The search index is not available
poolifier - v3.0.11Class FixedClusterPool<Data, Response>
A cluster pool with a fixed number of workers.
Author
Christopher Quadflieg
Since
2.0.0
Type Parameters
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
Type of execution response. This can only be structured-cloneable data.
-Hierarchy
Index
Constructors
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Constructs a new poolifier fixed cluster pool.
+Constructors
constructor
Constructs a new poolifier fixed cluster pool.
Type Parameters
Data = unknown
Response = unknown
Parameters
numberOfWorkers: number
Number of workers for this pool.
filePath: string
Path to an implementation of a
ClusterWorkerfile, which can be relative or absolute.opts: ClusterPoolOptions = {}
Options for this fixed cluster pool.
-Returns FixedClusterPool<Data, Response>
Properties
OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +
Returns FixedClusterPool<Data, Response>
Properties
OptionalemitterEvent 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:
@@ -70,109 +70,109 @@ The async tracking tooling identifier is
-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).ProtectedReadonlyfilePath to the worker file.
-ProtectedOptionalReadonlymaxDynamic pool maximum size property placeholder.
-ProtectedReadonlynumberNumber of workers that this pool should manage.
-ProtectedReadonlyoptsOptions for this fixed cluster pool.
-ProtectedpromiseThe task execution response promise map:
+ProtectedReadonlyfilePath to the worker file.
+ProtectedOptionalReadonlymaxDynamic pool maximum size property placeholder.
+ProtectedReadonlynumberNumber of workers that this pool should manage.
+ProtectedReadonlyoptsOptions for this fixed cluster pool.
+ProtectedpromiseThe 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.
-ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-ReadonlyInternalworkerPool worker nodes.
-Accessors
ProtectedbusyWhether the pool is busy or not.
+ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
+ReadonlyInternalworkerPool worker nodes.
+Accessors
ProtectedbusyWhether the pool is busy or not.
The pool busyness boolean status.
-Returns boolean
ProtectedfullWhether the pool is full or not.
+Returns boolean
ProtectedfullWhether the pool is full or not.
The pool filling boolean status.
-Returns boolean
info
Pool information.
-Returns PoolInfo
ProtectedmaxThe pool maximum size.
-Returns number
ProtectedminThe pool minimum size.
-Returns number
PrivatereadyThe pool readiness boolean status.
-Returns boolean
ProtectedtypeThe pool type.
+Returns boolean
info
Pool information.
+Returns PoolInfo
ProtectedmaxThe pool maximum size.
+Returns number
ProtectedminThe pool minimum size.
+Returns number
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 "fixed" | "dynamic"
PrivateutilizationThe approximate pool utilization.
Returns number
The pool utilization.
-ProtectedworkerThe worker type.
-Returns "thread" | "cluster"
Methods
add
Adds a task function to this pool. +
ProtectedworkerThe worker type.
+Returns "thread" | "cluster"
Methods
add
Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.
Parameters
name: string
The name of the task function.
fn: TaskFunction<Data, Response>
The task function.
Returns Promise<boolean>
trueif the task function was added,falseotherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
nameparameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
-fnparameter is not a function.ProtectedafterHook executed after the worker task execution. +
ProtectedafterHook executed after the worker task execution. Can be overridden.
Parameters
workerNodeKey: number
The worker node key.
message: MessageValue<Response, unknown>
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
workerNodeKey: number
The newly created worker node key.
-Returns void
ProtectedbeforeHook executed before the worker task execution. +
Returns void
ProtectedbeforeHook executed before the worker task execution. Can be overridden.
Parameters
workerNodeKey: number
The worker node key.
task: Task<Data>
The task to execute.
-Returns void
ProtectedcreateCreates a new, completely set up dynamic worker node.
+Returns void