X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=e8b72506f4c49ce6987cf3c620b54dd1296f57f9;hb=562a40378f9221d89759ddf99a675324ef4deb02;hp=9207f5005de2714305243506df84e80215bc7963;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 9207f500..e8b72506 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Readonly
listLists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Readonly
setSets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-The worker node tasks queue options.
+Readonly
setSets the worker choice strategy in this pool.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Readonly
setSets the worker choice strategy options in this pool.
The worker choice strategy options.
-Readonly
workerReadonly
Internal
workerPool worker nodes.
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
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.
@@ -58,7 +58,9 @@ emitter? enable Tasks Queue
execute
+has Worker Node Back Pressure
info
+list Task Functions
set Tasks Queue Options
set Worker Choice Strategy
set Worker Choice Strategy Options
@@ -67,7 +69,7 @@
-
destroy: (() => Promise<void>)
- (): Promise<void>
-
-
+ - Defined in src/pools/pool.ts:235
emitter?: PoolEmitter
+Defined in src/pools/pool.ts:218
- Tasks Queue
enable Tasks Queue: ((enable, tasksQueueOptions?) => void)
- (enable, tasksQueueOptions?): void
-
-
-
-
+
-
-
+
+Defined in src/pools/pool.ts:266
-execute: ((data?, name?) => Promise<Response>)
+execute: ((data?, name?, transferList?) => Promise<Response>)
-
+
+
Properties
destroy
+Readonly
destroyType declaration
@@ -76,29 +78,32 @@Terminate 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.
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 at least one task.'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
@@ -107,34 +112,32 @@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.
+Optional
Returns void
execute
-
+Readonly
executeType declaration
-- (data?, name?): Promise<Response>
+- (data?, name?, transferList?): Promise<Response>
-
@@ -143,19 +146,45 @@
-
-
+
-
-
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
-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
+
+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.
+Optional
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
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