X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=e47007644f326d0f597368c00ba04242c6cce985;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=43cd610eefdf892c836cea47fbc633cc309784b7;hpb=0770fe626b2bb3212a1d73fa4764973ac92e241a;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 43cd610e..e4700764 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier

Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

@@ -22,19 +22,27 @@

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.
Response = unknown
-
Type of response of execution. This can only be serializable data.
+
Type of execution response. This can only be serializable data.

Hierarchy

IPool

@@ -44,8 +52,14 @@

Properties

destroy emitter? +enableTasksQueue execute +findFreeWorkerNodeKey +setTasksQueueOptions setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +type +workerNodes

Properties

@@ -63,51 +77,119 @@

Returns Promise<void>

Defined in src/pools/pool.ts:163

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

'busy'
'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.

Defined in src/pools/pool.ts:142

enableTasksQueue

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

Type declaration

+
- (enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
- +
  Enables/disables the worker tasks queue in this pool.
  +
  +
  +
  Parameters
  +
  - +
    enable: boolean
    +
    Whether to enable or disable the worker tasks queue.
    +
  - +
    Optional tasksQueueOptions: TasksQueueOptions
    +
    The worker tasks queue options.
    +
  +
  Returns void

execute

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

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

Type declaration

+
- (data?: Data): Promise<Response>
- +
  Executes the function specified in the worker constructor with the task data input parameter.
  + +
  Returns
  Promise that will be fulfilled when the task is completed.
  +
  +
  +
  Parameters
  +
  - +
    Optional data: Data
    +
    The task input data for the specified worker function. This can only be serializable data.
    +
  +
  Returns Promise<Response>

findFreeWorkerNodeKey

findFreeWorkerNodeKey: (() => number)

Type declaration

- (data: Data): Promise<Response>
- (): number
- -
  Performs the task specified in the constructor with the data parameter.
  +
  Finds a free worker node key based on the number of tasks the worker has applied.
  +
  If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
  +
  If no free worker is found, -1 is returned.
  -
  Returns
  Promise that will be resolved when the task is successfully completed.
  +
  Returns
  A worker node key if there is one, -1 otherwise.
  +
  +
  Returns number

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

Type declaration

+
- (tasksQueueOptions: 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.
    +
    tasksQueueOptions: TasksQueueOptions
    +
    The worker tasks queue options.
  -
  Returns Promise<Response>

Defined in src/pools/pool.ts:197

setWorkerChoiceStrategy

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

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

Type declaration

- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
- Sets the worker choice strategy in this pool.
  
  @@ -117,14 +199,56 @@
- workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
  
  The worker choice strategy.
  +
- +
  Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
  +

Returns void

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => void)

Type declaration

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