X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=356689c979e7180094bd77a5ac1eb6d7e4233d90;hb=862503b9f2480d51bf3a666fc4d1d2a9b3c06b33;hp=1e4c66566e4bfccfa8acbe848e4fb0283c79717f;hpb=a99f06d1fff8949584cd630bfaa3fa2e3cc3897e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 1e4c6656..356689c9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,15 +1,16 @@ -
Type of worker which manages this pool.
+Contract definition for a poolifier pool.
+Type of worker which manages this pool.
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.
-Readonly
addAdds 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.
+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.
Readonly
destroyTerminates all workers in this pool.
-Optional
Readonly
emitterPool event emitter integrated with async resource. +
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function or task function object.
Readonly
destroyTerminates all workers in this pool.
+Optional
Readonly
emitterPool event emitter integrated with async resource.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
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).
Readonly
enableEnables/disables the worker node tasks queue in this pool.
+Readonly
enableEnables/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.
-Readonly
executeExecutes the specified function in the worker constructor with the task data input parameter.
+Readonly
executeExecutes 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.
-Readonly
hasWhether the specified task function exists in this pool.
+Optional
transferList: 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.
+Readonly
hasWhether the specified task function exists in this pool.
The name of the task function.
true
if the task function exists, false
otherwise.
Readonly
infoPool information.
-Readonly
listLists the names of task function available in this pool.
-The names of task function available in this pool.
-Readonly
removeRemoves a task function from this pool.
-The name of the task function.
+Readonly
infoPool information.
+Readonly
listLists the properties of task functions available in this pool.
+The properties of task functions available in this pool.
+Readonly
mapExecutes the specified function in the worker constructor with the tasks data iterable input parameter.
+The tasks iterable input data for the specified task function. This can only be an iterable of 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: 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.
+Readonly
removeRemoves a task function from this pool.
+The name of the task function.
true
if the task function was removed, false
otherwise.
Readonly
setSets the default task function in this pool.
-The name of the task function.
+Readonly
setSets the default task function in this pool.
+The name of the task function.
true
if the default task function was set, false
otherwise.
Readonly
setSets the worker node tasks queue options in this pool.
-The worker node tasks queue options.
-Readonly
setSets the worker choice strategy in this pool.
-The worker choice strategy.
+Readonly
setSets the worker node tasks queue options in this pool.
+The worker node tasks queue options.
+Readonly
setSets the default worker choice strategy in this pool.
+The default worker choice strategy.
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Readonly
setSets the worker choice strategy options in this pool.
-The worker choice strategy options.
-Readonly
startStarts the minimum number of workers in this pool.
-Readonly
Internal
workerPool worker nodes.
-Generated using TypeDoc
Readonly
setSets the worker choice strategy options in this pool.
+The worker choice strategy options.
+true
if the worker choice strategy options were set, false
otherwise.
Readonly
startStarts the minimum number of workers in this pool.
+Readonly
Internal
workerPool worker nodes.
+
Contract definition for a poolifier pool.
-