X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=4250db86e69237e714a317b703f51e88c515e38c;hb=5e133e82f086deb4b1ad5803b5df64ff924c69f1;hp=2fe23e4d6e9c51832a4786c768a6eaef8bc50d37;hpb=b73887071ac359b50a7f117a76b3edf268841aac;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 2fe23e4d..4250db86 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.12Interface 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);
    hasWorkerNodeBackPressure: ((workerNodeKey) => 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
Returns Promise<boolean>
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
destroyType 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. +
Readonly
destroyType 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. The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
@@ -38,36 +38,36 @@ 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
enableType declaration
Enables/disables the worker node tasks queue in this pool.
+Readonly
enableType 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
Readonly
executeType declaration
Executes the specified function in the worker constructor with the task data input parameter.
+Returns void
Readonly
executeType 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.
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.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
-Readonly
hasType declaration
Whether the specified task function exists in this pool.
+Readonly
hasType 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.Readonly
hasType declaration
Internal
Whether the worker node has back pressure (i.e. its tasks queue is full).
+Readonly
hasType declaration
Internal
Whether the worker node has back pressure (i.e. its tasks queue is full).
Parameters
workerNodeKey: number
The worker node key.
Returns boolean
-true
if the worker node has back pressure,false
otherwise.Readonly
infoPool information.
-Readonly
listType declaration
Lists the names of task function available in this pool.
+Readonly
infoPool information.
+Readonly
listType declaration
Lists the names of task function available in this pool.
Returns string[]
The names of task function available in this pool.
-Readonly
removeType declaration
Removes a task function from this pool.
+Readonly
removeType 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.Readonly
setType declaration
Sets the default task function in this pool.
+Readonly
setType 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.Readonly
setType declaration
Sets the worker node tasks queue options in this pool.
+Readonly
setType declaration
Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
The worker node tasks queue options.
-Returns void
Readonly
setType declaration
Sets the worker choice strategy in this pool.
+Returns void
Readonly
setType 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
Readonly
setType declaration
Sets the worker choice strategy options in this pool.
+Returns void
Readonly
setType declaration
Sets the worker choice strategy options in this pool.
Parameters
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
The worker choice strategy options.
-Returns void
Readonly
startType 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
startType 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