X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=b1c1b5956b013152fe53786626e3c06fdd5ba676;hb=8735b4e51c0cfabc9612d57417834d42042cab4e;hp=740e3b8eb00235c2d5f748a35952d59f3e1aafe5;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 740e3b8e..b1c1b595 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
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:223
emitter?: PoolEmitter
+Defined in src/pools/pool.ts:206
- Tasks Queue
enable Tasks Queue: ((enable, tasksQueueOptions?) => void)
+Defined in src/pools/pool.ts:254
-execute: ((data?, name?) => Promise<Response>)
+execute: ((data?, name?, transferList?) => Promise<Response>)
-
+Defined in src/pools/pool.ts:178
+
+list Task Functions: (() => string[])
+
+
- Tasks Queue Options
set Tasks Queue Options: ((tasksQueueOptions) => void)
-
+Defined in src/pools/pool.ts:263
- Worker Choice Strategy
set Worker Choice Strategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
-
+Defined in src/pools/pool.ts:236
- Worker Choice Strategy Options
set Worker Choice Strategy Options: ((workerChoiceStrategyOptions) => void)
-
+Defined in src/pools/pool.ts:245
-worker Nodes: WorkerNode<Worker, Data>[]
+worker Nodes: IWorkerNode<Worker, Data>[]
+Defined in src/pools/pool.ts:184
Properties
destroy
+Readonly
destroyType declaration
@@ -76,29 +78,32 @@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.
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 >= pool maximum size^2).enable Tasks Queue
+Readonly
enableType declaration
@@ -125,16 +130,16 @@Returns void
execute
-
+Readonly
executeType declaration
-- (data?, name?): Promise<Response>
+- (data?, name?, transferList?): Promise<Response>
-
@@ -143,19 +148,49 @@
-
-
+
+-
+
+ - Defined in src/pools/pool.ts:215
+
+has Worker Node Back Pressure: ((workerNodeKey) => boolean)
+
+
info: PoolInfo
@@ -163,16 +198,33 @@
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.
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 Functions
+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.
+ +set Tasks Queue Options
+Readonly
setType declaration
-- (tasksQueueOptions): void
+- (tasksQueueOptions): void
-
@@ -187,16 +239,16 @@
Sets the worker tasks queue options in this pool.
Returns void
set Worker Choice Strategy
+Readonly
setType declaration
-- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
+- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
@@ -204,7 +256,7 @@
-
-
@@ -216,16 +268,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,15 +292,15 @@
Sets the worker choice strategy options in this pool.
Returns void
Nodes
-Readonly
worker Nodes
+Readonly
Internal
workerPool worker nodes.