X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=99b3123235930202c64ede122fdb3b70af5ef328;hb=4ee786575c19cfc95faa0dfc2671b3ab8f680402;hp=740e3b8eb00235c2d5f748a35952d59f3e1aafe5;hpb=4f487526a63c873d168386250b40ad8103c5a4d8;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 740e3b8e..99b31232 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
-
+Index
Index
Properties
-Properties
+ Task Function
+Readonly
addType declaration
++-
+
+- (name, fn): Promise<boolean>
+-
+
+
+
+
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+Parameters
++-
+
+
+-
+
+
name: string
+The name of the task function.
+fn: TaskFunction<Data, Response>
+The task function.
+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.destroy
+Readonly
destroyType declaration
-- (): Promise<void>
+- (): Promise<void>
-
-
+ - Defined in src/pools/pool.ts:259
Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
-Optional
Readonly
emitterEmitter on which events can be listened to.
+Event 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:
-
-
+
+
+
+
+
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are 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.'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).enable Tasks Queue
+Readonly
enableType declaration
-- (enable, tasksQueueOptions?): void
+- (enable, tasksQueueOptions?): void
-
-
-
-
+ - Defined in src/pools/pool.ts:325
-execute: ((data?, name?) => Promise<Response>)
+execute: ((data?, name?, transferList?) => Promise<Response>)
-
+- Defined in src/pools/pool.ts:209
+
+list Task Function Names: (() => string[])
+
+
+
+remove Task Function: ((name) => Promise<boolean>)
+
+
+
+set Default Task Function: ((name) => Promise<boolean>)
+
+
- Tasks Queue Options
set Tasks Queue Options: ((tasksQueueOptions) => void)
-
-
+
-
-
\ No newline at end of file
+
+
\ No newline at end of file
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
-Whether to enable or disable the worker tasks queue.
+Whether to enable or disable the worker node tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Returns void
execute
-
+Readonly
executeType declaration
-- (data?, name?): Promise<Response>
+- (data?, name?, transferList?): Promise<Response>
-
@@ -143,19 +189,74 @@
-
-
+
+-
+
+ - Defined in src/pools/pool.ts:247
+
+has Task Function: ((name) => boolean)
+
+
+
+has Worker Node Back Pressure: ((workerNodeKey) => boolean)
+
+
info: PoolInfo
@@ -163,40 +264,107 @@
Executes the specified function in the worker constructor with the task data input parameter.
-Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+The optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The 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 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.
Task Function
+Readonly
hasType declaration
++-
+
+- (name): boolean
+-
+
+
+
+
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. Worker Node Back Pressure
+Readonly
hasType declaration
++-
+
+- (workerNodeKey): boolean
+
+
+
+
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
info Task Function Names
+Readonly
listType declaration
++-
+
+- (): string[]
+-
+
+
Lists the names of task function available in this pool.
+Returns string[]
The names of task function available in this pool.
+ + Task Function
+Readonly
removeType declaration
++-
+
+- (name): Promise<boolean>
+-
+
+
+
+
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. Default Task Function
+Readonly
setType declaration
++-
+
+- (name): Promise<boolean>
+-
+
+
+
+
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.set Tasks Queue Options
+Readonly
setType declaration
-- (tasksQueueOptions): void
+- (tasksQueueOptions): void
-
-
-
+- Defined in src/pools/pool.ts:334
- Worker Choice Strategy
set Worker Choice Strategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
-
+- Defined in src/pools/pool.ts:307
- Worker Choice Strategy Options
set Worker Choice Strategy Options: ((workerChoiceStrategyOptions) => void)
-
+- Defined in src/pools/pool.ts:316
+
+start: (() => void)
+
+
-worker Nodes: WorkerNode<Worker, Data>[]
+worker Nodes: IWorkerNode<Worker, Data>[]
+ - Defined in src/pools/pool.ts:215
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
-The worker tasks queue options.
+The worker node tasks queue options.
Returns void
set Worker Choice Strategy
+Readonly
setType declaration
-- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
+- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
@@ -204,7 +372,7 @@
-
-
@@ -216,16 +384,16 @@
Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
Returns void
set Worker Choice Strategy Options
+Readonly
setType declaration
-- (workerChoiceStrategyOptions): void
+- (workerChoiceStrategyOptions): void
-
@@ -240,20 +408,36 @@
Sets the worker choice strategy options in this pool.
Returns void
+Readonly
startType declaration
++-
+
+- (): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+ Nodes
-Readonly
worker Nodes
+Readonly
Internal
workerPool worker nodes.
-
+Settings
Settings
Member Visibility
Generated using TypeDoc
Generated using TypeDoc