X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=1d9b8d8b84ee14b5a4bdfabeb9678ae4dcc6300f;hb=dd7dfcc292a646940f5f0263d24d8f5f528e8a51;hp=08cf199db605182faa03c59bc7b3ef5e04cd156b;hpb=c62a9bbc12416e26acbb3b86b5090d6186b14b60;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 08cf199d..1d9b8d8b 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Path to the worker file.
-Options for the pool.
-Emitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'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.'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
fileProtected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
Readonly
numberProtected
Readonly
optsProtected
promisePrivate
Readonly
startPrivate
startedWhether the pool is started or not.
+Private
Readonly
startingProtected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
Abstract
maxProtected
maxProtected
Abstract
minProtected
minPrivate
readyProtected
Abstract
typePrivate
utilizationProtected
Abstract
workerThe worker type.
The worker.
-The added worker node key.
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected
afterThe worker node key.
-The received message.
-Protected
afterThe newly created worker node key.
-Protected
beforeThe worker node key.
-The task to execute.
-Private
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
checkPrivate
checkPrivate
checkThe received message.
-https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
chooseProtected
createProtected
createProtected
Abstract
createPrivate
dequeueProtected
Abstract
destroyThe worker node key.
-Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-The worker node tasks queue options.
+Optional
Private
enqueueExecutes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
-The 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.
Private
executeThe worker node key.
-The task to execute.
-Protected
flushPrivate
flushProtected
getGets the worker information given its worker node key.
The worker node key.
-The worker information.
+ +The worker information.
Private
getThe worker.
-The worker node key if found in the pool worker nodes, -1
otherwise.
Private
getThe worker id.
-The worker node key if the worker id is found in the pool worker nodes, -1
otherwise.
Private
handlePrivate
handlePrivate
hasProtected
internalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Worker nodes busyness boolean status.
+Protected
Abstract
isPrivate
redistributeProtected
Abstract
registerThe worker node key.
-The message listener callback.
Private
removeThe worker.
-Protected
sendProtected
Abstract
sendThe worker node key.
+Private
sendSends the statistics message to worker given its worker node key.
The worker node key.
+Protected
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.
+Optional
Private
sendPrivate
setSends the worker statistics message to worker given its worker node key.
-The worker node key.
-Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-The worker node tasks queue options.
+The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected
setupPrivate
shallPrivate
shallPrivate
shallWhether the worker node shall update its task function worker usage or not.
+The worker node key.
+true
if the worker node shall update its task function worker usage, false
otherwise.
Private
startPrivate
taskPrivate
tasksPrivate
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Number of workers that this pool should manage.
-