X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=cd25d801b3f4bb2de581e3cbdb83026199cbd969;hb=061c73fe2b7d67ed9f106557bc058b3ed80f1163;hp=f4e12f782008b10bf21e66d14a8c90c61519a2e3;hpb=19b53d08bec0e752fb3bdf054a0810db8bb8565d;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index f4e12f78..cd25d801 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,8 +1,8 @@ -
Contract definition for a poolifier pool.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.20Interface 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;
    listTaskFunctionNames: (() => string[]);
    removeTaskFunction: ((name) => Promise<boolean>);
    setDefaultTaskFunction: ((name) => Promise<boolean>);
    setTasksQueueOptions: ((tasksQueueOptions) => void);
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
    start: (() => void);
    workerNodes: IWorkerNode<Worker, Data>[];
}
Type Parameters
Worker extends IWorker
Type of worker which manages this pool.
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
Type of execution response. This can only be structured-cloneable data.
-Implemented by
Index
Properties
Implemented by
Index
Properties
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.
+Readonly
destroyTerminates all workers in this pool.
Type declaration
Terminates all workers in this pool.
-Returns Promise<void>
Optional
Readonly
emitterEvent emitter integrated with async resource on which events can be listened to. +
Returns Promise<void>
Optional
Readonly
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.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.'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.'empty'
: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum 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).Readonly
enableEnables/disables the worker node tasks queue in this pool.
+Readonly
enableEnables/disables the worker node tasks queue in this pool.
Type declaration
Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
Whether to enable or disable the worker node tasks queue.
Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
Returns void
Param: enable
Whether to enable or disable the worker node tasks queue.
Param: tasksQueueOptions
The 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.
Type declaration
Executes the specified function in the worker constructor with the task data input parameter.
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.
@@ -61,44 +62,44 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo
Param: name
The optional name of the task function to execute. If not specified, the default task function will be executed.
Param: transferList
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 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
Whether the specified task function exists in this pool.
Parameters
name: string
The name of the task function.
Returns boolean
true
if the task function exists,false
otherwise.Param: name
The name of the task function.
Returns
-true
if the task function exists,false
otherwise.Readonly
infoPool information.
-Readonly
listLists the names of task function available in this pool.
+Readonly
infoPool information.
+Readonly
listLists the names of task function available in this pool.
Type declaration
Lists the names of task function available in this pool.
Returns string[]
The names of task function available in this pool.
Returns
The names of task function available in this pool.
-Readonly
removeRemoves a task function from this pool.
+Readonly
removeRemoves a task function from this pool.
Type declaration
Removes a task function from this pool.
Parameters
name: string
The name of the task function.
Returns Promise<boolean>
true
if the task function was removed,false
otherwise.Param: name
The name of the task function.
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
Sets the default task function in this pool.
Parameters
name: string
The name of the task function.
Returns Promise<boolean>
true
if the default task function was set,false
otherwise.Param: name
The name of the task function.
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
Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
Returns void
Param: tasksQueueOptions
The worker node tasks queue options.
-Readonly
setSets the worker choice strategy in this pool.
+Readonly
setSets the worker choice strategy in this pool.
Type declaration
Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Returns void
Param: workerChoiceStrategy
The worker choice strategy.
Param: workerChoiceStrategyOptions
The worker choice strategy options.
-Readonly
setSets the worker choice strategy options in this pool.
+Readonly
setSets the worker choice strategy options in this pool.
Type declaration
Sets the worker choice strategy options in this pool.
Parameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
Returns void
Param: workerChoiceStrategyOptions
The worker choice strategy options.
-Readonly
startStarts the minimum number of workers in this pool.
+Readonly
startStarts the minimum number of workers in this pool.
Type declaration
Starts the minimum number of workers in this pool.
-Returns void
Readonly
Internal
workerPool worker nodes.
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Returns void
Readonly
Internal
workerPool worker nodes.
+Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc