X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=86b5dfb4e38f03c66483b5e680d9bf9d156e71a7;hb=b83746e48f09324273c37450e1adefbd4c13efe3;hp=4189fd7cf7a390be42485c8b8959193396d87cff;hpb=f30cddb8f07ac919d75140469faab6e0883709da;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 4189fd7c..86b5dfb4 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,8 +1,8 @@ -
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.
+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.
-Readonly
startStarts the minimum number of workers in this pool.
+Readonly
Internal
workerPool worker nodes.
+
Contract definition for a poolifier pool.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.13Interface IPool<Worker, Data, Response>
Contract definition for a poolifier pool.
    addTaskFunction: ((name, fn) => Promise<boolean>);
    destroy: (() => Promise<void>);
    emitter?: EventEmitterAsyncResource;
    enableTasksQueue: ((enable, tasksQueueOptions?) => void);
    execute: ((data?, name?, transferList?) => Promise<Response>);
    hasTaskFunction: ((name) => boolean);
    info: PoolInfo;
    listTaskFunctionsProperties: (() => TaskFunctionProperties[]);
    removeTaskFunction: ((name) => Promise<boolean>);
    setDefaultTaskFunction: ((name) => Promise<boolean>);
    setTasksQueueOptions: ((tasksQueueOptions) => void);
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => boolean);
    start: (() => void);
    workerNodes: IWorkerNode<Worker, Data>[];
}
Type Parameters
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.
-Implemented by
Index
Properties
Implemented by
Index
Properties
Properties
Readonly
addAdds a task function to this pool. If a task function with the same name already exists, it will be overwritten.
Type declaration
Parameters
The name of the task function.
-The task function.
+The task function.
Returns Promise<boolean>
Returns
true
if the task function was added,false
otherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
-name
parameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
-fn
parameter is not a function.Readonly
destroyTerminates all workers in this pool.
-Type declaration
Returns Promise<void>
Optional
Readonly
emitterPool event emitter integrated with async resource. +
Throws
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.
+Type declaration
Returns Promise<void>
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:
@@ -38,34 +38,34 @@ 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).Readonly
enableEnables/disables the worker node tasks queue in this pool.
+Readonly
enableEnables/disables the worker node tasks queue in this pool.
Type declaration
Parameters
Whether to enable or disable the worker node tasks queue.
Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Returns void
Readonly
executeExecutes the specified function in the worker constructor with the task data input parameter.
+Returns void
Readonly
executeExecutes the specified function in the worker constructor with the task data input parameter.
Type declaration
Parameters
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.
Returns Promise<Response>
Returns
Promise that will be fulfilled when the task is completed.
-Readonly
hasWhether the specified task function exists in this pool.
+Readonly
hasWhether the specified task function exists in this pool.
Type declaration
Parameters
The name of the task function.
Returns boolean
Returns
-true
if the task function exists,false
otherwise.Readonly
infoPool information.
-Readonly
listLists the properties of task functions available in this pool.
+Readonly
infoPool information.
+Readonly
listLists the properties of task functions available in this pool.
Type declaration
Returns TaskFunctionProperties[]
Returns
The properties of task functions available in this pool.
-Readonly
removeRemoves a task function from this pool.
+Readonly
removeRemoves a task function from this pool.
Type declaration
Parameters
The name of the task function.
Returns Promise<boolean>
Returns
-true
if the task function was removed,false
otherwise.Readonly
setSets the default task function in this pool.
+Readonly
setSets the default task function in this pool.
Type declaration
Parameters
The name of the task function.
Returns Promise<boolean>
Returns
-true
if the default task function was set,false
otherwise.Readonly
setSets the worker node tasks queue options in this pool.
+Readonly
setSets the worker node tasks queue options in this pool.
Type declaration
Parameters
The worker node tasks queue options.
-Returns void
Readonly
setSets the default worker choice strategy in this pool.
+Returns void