X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=61d1b615339d614f5a4bdc682e20f12d7041e67f;hb=2a6631992868d900762f62e4c228dce4e4ee549a;hp=7439713da5a26089e0a247f01165c0089991309a;hpb=b08b5fc507f21848c9435380edb7d155e92eaaf5;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7439713d..b6acf4dc 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.

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,62 +54,149 @@

Properties

emitter? -

Methods

destroy -execute -setWorkerChoiceStrategy +

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

destroy

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

Type declaration

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

`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.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

Methods

destroy

destroy(): Promise<void>
Defined in src/pools/pool.ts:186

enableTasksQueue

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

Type declaration

+
- (enable, tasksQueueOptions?): void
- -
  Shutdowns every current worker in this pool.
  +
  Enables/disables the worker tasks queue in this pool.
  
  -
  Returns Promise<void>
  +
  +
  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>
Defined in src/pools/pool.ts:223

execute

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

Type declaration

+
- (data?, name?): Promise<Response>
- -
  Performs the task specified in the constructor with the data parameter.
  +
  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.

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

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
Defined in src/pools/pool.ts:232

setWorkerChoiceStrategy

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

Type declaration

+
- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Sets the worker choice strategy in this pool.
  
  @@ -105,16 +204,56 @@
  Parameters
  - -
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "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

Defined in src/pools/pool.ts:205

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
  +