Abstract Private buildPrivate checkPrivate checkPrivate checkPrivate checkChecks if the worker id sent in the received message from a worker is valid.
The received message.
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
-Private checkPrivate checkPrivate checkPrivate choosePrivate checkPrivate checkPrivate checkPrivate chooseProtected createCreates a new, completely set up dynamic worker node.
+Protected createProtected createCreates a new, completely set up worker node.
+Protected createProtected Abstract createCreates a new worker.
+Protected Abstract createPrivate deletePrivate dequeueProtected Abstract deregisterDeregisters a listener callback on the worker given its worker node key.
+Private deletePrivate dequeueProtected Abstract deregisterDeregisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
-Protected Abstract destroyTerminates the worker node given its worker node key.
+Protected Abstract 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.
-Private enqueuePrivate enqueueExecutes 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 pool's worker_threads worker and they should not be used in the main thread afterwards.
+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.
-Private executeExecutes the given task on the worker given its worker node key.
+Private executeExecutes the given task on the worker given its worker node key.
The worker node key.
The task to execute.
-Protected flagProtected flushPrivate flushProtected getGets the worker information given its worker node key.
+Protected flagProtected flushPrivate flushProtected getGets the worker information given its worker node key.
The worker node key.
The worker information.
-Private getGets the given worker its worker node key.
+Private getPrivate getGets the worker node key given its worker id.
+Private getPrivate Readonly handlePrivate Readonly handlePrivate handlePrivate handlePrivate hasWhether the specified task function exists in this pool.
+Private Readonly handlePrivate Readonly handleOptional previousStolenTask: Task<Data>Private handlePrivate handlePrivate hasInternal Whether the worker node has back pressure (i.e. its tasks queue is full).
+Private initializeProtected internalWhether worker nodes are executing concurrently their tasks quota or not.
+Private initializeProtected internalProtected Abstract isLists the names of task function available in this pool.
+Protected Abstract isPrivate redistributeProtected Abstract registerRegisters once a listener callback on the worker given its worker node key.
+Private redistributeProtected Abstract registerRegisters once a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
-Protected Abstract registerRegisters a listener callback on the worker given its worker node key.
+Protected Abstract 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.
+Private removePrivate resetPrivate resetProtected sendProtected Abstract sendPrivate sendPrivate sendPrivate sendPrivate sendProtected Abstract sendPrivate sendPrivate sendProtected Abstract sendSends a message to worker given its worker node key.
The worker node key.
The message.
Optional transferList: TransferListItem[]The optional array of transferable objects.
-Private setSets the worker node tasks queue options in this pool.
+Private setSets the worker node tasks queue options in this pool.
The worker node tasks queue options.
-Private setPrivate setPrivate setPrivate setSets 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 setupPrivate shallPrivate shallPrivate shallPrivate shallWhether the worker node shall update its task function worker usage or not.
+Private shallPrivate shallPrivate tasksPrivate unsetPrivate unsetPrivate updatePrivate updatePrivate updatePrivate updatePrivate updateProtected workerThis method is the message listener registered on each worker.
-Generated using TypeDoc
Private tasksPrivate unsetPrivate unsetPrivate updatePrivate updatePrivate updatePrivate updatePrivate updatePrivate updatePrivate updateProtected Readonly workerThis method is the message listener registered on each worker.
+Private Readonly workerGenerated using TypeDoc
Base class that implements some shared logic for all poolifier pools.
+- Preparing search index...
- The search index is not available
poolifier - v3.0.13Class AbstractPool<Worker, Data, Response>
AbstractBase class that implements some shared logic for all poolifier pools.
Type Parameters
Worker extends IWorker
Type of worker which manages this pool.
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
Implements
Index
Constructors
Properties
Hierarchy
Implements
Index
Constructors
Properties
Constructors
constructor
Constructs a new poolifier pool.
+workerConstructors
constructor
Constructs a new poolifier pool.
Type Parameters
Worker extends IWorker
Data = unknown
Response = unknown
Parameters
numberOfWorkers: number
Number of workers that this pool should manage.
filePath: string
Path to the worker file.
opts: PoolOptions<Worker>
Options for the pool.
-Returns AbstractPool<Worker, Data, Response>
Properties
OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +
Returns AbstractPool<Worker, Data, Response>
Properties
PrivatedestroyingWhether the pool is destroying or not.
+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:
@@ -115,146 +123,147 @@ 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 the 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 the 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.
-PrivateReadonlystartThe start timestamp of the pool.
-PrivatestartedWhether the pool is started or not.
-PrivatestartingWhether the pool is starting or not.
-PrivateReadonlytaskThe task functions added at runtime map:
+PrivatereadyWhether the pool ready event has been emitted or not.
+PrivateReadonlystartThe start timestamp of the pool.
+PrivatestartedWhether the pool is started or not.
+PrivatestartingWhether the pool is starting or not.
+PrivateReadonlytaskThe task functions added at runtime map:
-key: The task function name.value: The task function itself.ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-ReadonlyInternalworkerPool worker nodes.
-Accessors
ProtectedAbstractbusyWhether the pool is busy or not.
+ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
+ReadonlyInternalworkerPool worker nodes.
+Accessors
ProtectedAbstractbusyWhether 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
ProtectedAbstracttypeThe 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
ProtectedAbstracttypeThe 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.
-ProtectedAbstractworkerThe worker type.
-Returns "thread" | "cluster"
Methods
add
Adds a task function to this pool. +
ProtectedAbstractworkerThe 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.PrivateaddAdds the given worker in the pool worker nodes.
+PrivateaddAdds the given worker in the pool worker nodes.
Parameters
worker: Worker
The worker.
Returns number
The added worker node key.
Throws
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
-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
PrivatebuildParameters
tasksQueueOptions: TasksQueueOptions
Returns TasksQueueOptions
PrivatecheckReturns void
PrivatecheckReturns void
PrivatecheckReturns void
PrivatecheckChecks if the worker id sent in the received message from a worker is valid.
+Returns void