X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=d706dad9582035dcadb4311ddd3455441468ff05;hb=9867896b122160ea5d8e6dbccba4cc5916bf523b;hp=6ad17b4cd4fe5f86d56a0b43772e8aab964041eb;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 6ad17b4c..d706dad9 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
destroy
+Readonly
destroyType declaration
@@ -76,29 +79,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 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
@@ -107,34 +113,34 @@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 +149,49 @@
-
-
+
+-
+
+ - Defined in src/pools/pool.ts:250
+
+has Worker Node Back Pressure: ((workerNodeKey) => boolean)
+
+
info: PoolInfo
@@ -163,40 +199,57 @@
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
-
-
-
+- Defined in src/pools/pool.ts:302
- Worker Choice Strategy
set Worker Choice Strategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
-
+- Defined in src/pools/pool.ts:275
- Worker Choice Strategy Options
set Worker Choice Strategy Options: ((workerChoiceStrategyOptions) => void)
-
+- Defined in src/pools/pool.ts:284
+
+start: (() => void)
+
+
-worker Nodes: WorkerNode<Worker, Data>[]
+worker Nodes: IWorkerNode<Worker, Data>[]
+ - Defined in src/pools/pool.ts:219
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
-
@@ -216,16 +269,16 @@
Sets the worker choice strategy in this pool.
Returns void
set Worker Choice Strategy Options
+Readonly
setType declaration
-- (workerChoiceStrategyOptions): void
+- (workerChoiceStrategyOptions): void
-
@@ -240,28 +293,44 @@
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
Theme
@@ -272,72 +341,39 @@- 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
+- start
- worker
Nodes
Generated using TypeDoc
Generated using TypeDoc