X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=7911f61f194612f589612577ae878dc8cc2912f9;hb=177be4a662e85919499d34984db6c77c6e5da5f6;hp=c06cfb370a722aeda2e2740cfb67659e8b86d730;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index c06cfb37..9cb858c6 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier - v2.6.16

Interface IPool<Data, Response>

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

Data = unknown

Type of data sent to the worker. This can only be structured-cloneable data.

-
Response = unknown
-
Type of response of execution. This can only be serializable data.
-

Response = unknown

Type of execution response. This can only be structured-cloneable data.

Hierarchy

IPool

@@ -42,73 +54,150 @@

Properties

destroy -emitter? -execute -setWorkerChoiceStrategy +

destroy +emitter? +enableTasksQueue +execute +info +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +workerNodes

Properties

destroy

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

`Readonly` destroy

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

Type declaration

-
- (): Promise<void>

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Defined in src/pools/pool.ts:203

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

execute

execute: ((data: Data) => Promise<Response>)

Defined in src/pools/pool.ts:191

`Readonly` enableTasksQueue

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

Type declaration

-
- (data: Data): Promise<Response>

`Readonly` execute

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

Type declaration

+
- (data?, name?): Promise<Response>
- +
  Executes the specified function in the worker constructor with the task data input parameter.
  +
  +
  +
  Parameters
  +
  - +
    Optional data: Data
    +
    The task input data for the specified worker function. This can only be structured-cloneable data.
    +
    +
  - +
    Optional name: string
    +
    The name of the worker function to execute. If not specified, the default worker function will be executed.
    +
    +
  +
  Returns Promise<Response>
  Promise that will be fulfilled when the task is completed.
  -
  Returns
  Promise that will be resolved when the task is successfully completed.
  +

`Readonly` info

info: PoolInfo

Pool information.

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

+
- (tasksQueueOptions): void
- +
  Sets the worker tasks queue options in this pool.
  Parameters
  - -
    data: Data
    -
    The input for the specified task. This can only be serializable data.
    -
  -
  Returns Promise<Response>

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)

Defined in src/pools/pool.ts:237

`Readonly` setWorkerChoiceStrategy

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

Type declaration

-
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void

Returns void

`Readonly` setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

Type declaration

+
- (workerChoiceStrategyOptions): void
- +
  Sets the worker choice strategy options in this pool.
  +
  +
  +
  Parameters
  +
  - +
    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    +
    The worker choice strategy options.
    +
    +
  +
  Returns void
  +