X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=86b5dfb4e38f03c66483b5e680d9bf9d156e71a7;hb=28bcd7a31d95fd283814fad692d77b4994c2ac9c;hp=cd25d801b3f4bb2de581e3cbdb83026199cbd969;hpb=2ec36b024551bb9f0ea4851d68958ff1866a50f3;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index cd25d801..86b5dfb4 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,39 +1,31 @@ -
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. +
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.
-Adds 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.
The name of the task function.
-The task function.
-true
if the task function was added, false
otherwise.
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.
Readonly
destroyTerminates all workers in this pool.
-Terminates all workers in this pool.
-Optional
Readonly
emitterEvent emitter integrated with async resource on which events can be listened to. +
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.
-Enables/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.
-Whether to enable or disable the worker node tasks queue.
-The worker node tasks queue options.
-Readonly
executeExecutes the specified function in the worker constructor with the task data input parameter.
-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.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
-The optional name of the task function to execute. If not specified, the default task function will be executed.
-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.
-Whether the specified task function exists in this pool.
-The name of the task function.
-true
if the task function exists, false
otherwise.
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.
-Lists the names of task function available in this pool.
-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.
-Removes a task function from this pool.
-The name of the task function.
-true
if the task function was removed, false
otherwise.
The name of the task function.
-true
if the task function was removed, false
otherwise.
Readonly
setSets the default task function in this pool.
-Sets the default task function in this pool.
-The name of the task function.
-true
if the default task function was set, false
otherwise.
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.
-Sets the worker node tasks queue options in this pool.
-The worker node tasks queue options.
-The worker node tasks queue options.
-Readonly
setSets the worker choice strategy in this pool.
-Sets the worker choice strategy in this pool.
-The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-The worker choice strategy.
-The worker choice strategy options.
-Readonly
setSets the worker choice strategy options in this pool.
-Sets the worker choice strategy options in this pool.
-The worker choice strategy options.
-The worker choice strategy options.
-Readonly
startStarts the minimum number of workers in this pool.
-Starts the minimum number of workers in this pool.
-Readonly
Internal
workerPool worker nodes.
-Generated using TypeDoc
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.
+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: 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 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 properties of task functions available in this pool.
+The properties of task functions available in this pool.
+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.
+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 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.
+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.
-