X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=57e9ccccfead65be11efd5eb325a391180142862;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=19a7d312c542f66cd74ead9afe576db2e660cee9;hpb=811dc01fd8bb1b23cc3e6e72f7fbc82cc8f473ae;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 19a7d312..57e9cccc 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier - v2.6.26

@@ -17,22 +17,26 @@

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

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 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.

Hierarchy

AbstractPool

Defined in src/pools/pool.ts:168

@@ -50,21 +54,21 @@

Properties

destroy

`Readonly` destroy

destroy: (() => Promise<void>)

Type declaration

@@ -73,25 +77,30 @@

(): Promise<void>
-
Shutdowns every current worker in this pool.
+
Terminates all workers in this pool.

-
Returns Promise<void>

Defined in src/pools/pool.ts:209

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter 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.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'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.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

Defined in src/pools/pool.ts:192

enableTasksQueue

`Readonly` enableTasksQueue

enableTasksQueue: ((enable, tasksQueueOptions?) => void)

Type declaration

@@ -108,23 +117,26 @@

enable: boolean

Whether to enable or disable the worker tasks queue.

`Optional` tasksQueueOptions: TasksQueueOptions

The worker tasks queue options.

Returns void

Defined in src/pools/pool.ts:240

execute

execute: ((data?, name?) => Promise<Response>)

`Readonly` execute

execute: ((data?, name?, transferList?) => Promise<Response>)

Type declaration

- (data?, name?): Promise<Response>
- (data?, name?, transferList?): Promise<Response>
- Executes the specified function in the worker constructor with the task data input parameter.
  
  @@ -133,25 +145,58 @@
  - Optional data: Data
    -
    The task input data for the specified worker function. This can only be serializable data.
    -
  - Optional name: string
    -
    The 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.

`Readonly` info

info: PoolInfo

Pool information.

`Readonly` listTaskFunctions

listTaskFunctions: (() => string[])

Type declaration

+
- (): string[]
- +
  Lists the names of task function available in this pool.
  +
  +
  Returns string[]
  The names of task function available in this pool.
  + +

Defined in src/pools/pool.ts:215

setTasksQueueOptions

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

- (tasksQueueOptions): void
- (tasksQueueOptions): void
- Sets the worker tasks queue options in this pool.
  
  @@ -161,19 +206,21 @@
- tasksQueueOptions: TasksQueueOptions
  
  The worker tasks queue options.
  -

Returns void

Defined in src/pools/pool.ts:249

setWorkerChoiceStrategy

`Readonly` setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

Type declaration

- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Sets the worker choice strategy in this pool.
  
  @@ -181,25 +228,28 @@
  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.
    -

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

The worker choice strategy options.

Returns void

Defined in src/pools/pool.ts:222

setWorkerChoiceStrategyOptions

`Readonly` setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

Type declaration

- (workerChoiceStrategyOptions): void
- (workerChoiceStrategyOptions): void
- Sets the worker choice strategy options in this pool.
  
  @@ -209,37 +259,25 @@
- workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  
  The worker choice strategy options.
  -