Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this fixed cluster pool.
-Optional Readonly emitterEmitter on which events can be listened to.
+Optional emitterEvent 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:
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.Protected Readonly fileProtected Optional Readonly maxProtected Readonly numberProtected Readonly optsProtected promiseThe task execution response promise map.
+The 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.Protected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationProtected workerAdds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true if the task function was added, false otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
Protected afterThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Protected checkProtected createProtected createProtected createProtected deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional 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 Promise that will be fulfilled when the task is completed.
Protected flushProtected getGets the worker information given its worker node key.
The worker node key.
-The worker information.
+ + +The worker information.
The worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected registerThe worker node key.
-The message listener callback.
Protected sendProtected sendThe worker node key.
-Protected sendThe worker node key.
-The message.
-The worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional The worker choice strategy options.
-Protected setupProtected workerThis method is the listener registered for each worker message.
+Starts the minimum number of workers in this pool.
The listener function to execute when a message is received from a worker.
- -Protected workerThis method is the listener registered for each worker message.
+This method is the message listener registered on each worker.
The listener function to execute when a message is received from a worker.
- - +Generated using TypeDoc
Number of workers for this pool.
-