X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=26706be591388e6711d133b5d89c868b9567d7b9;hb=c38a523624d95c0329fac3d0748883c361db9d93;hp=61d1b615339d614f5a4bdc682e20f12d7041e67f;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 61d1b615..26706be5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier - v2.6.30

@@ -14,27 +14,39 @@ -

Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

+ +

Type Parameters

-
Data = unknown
-
Type of data sent to the worker. This can only be serializable data.
-

Worker extends IWorker

Type of worker which manages this pool.

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

Hierarchy

IPool

@@ -42,73 +54,201 @@

Properties

destroy -emitter? -execute -setWorkerChoiceStrategy +

destroy +emitter? +enableTasksQueue +execute +hasWorkerNodeBackPressure +info +listTaskFunctions +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:224

`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.
'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.
'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 >= pool maximum size^2).

execute

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

Defined in src/pools/pool.ts:207

`Readonly` enableTasksQueue

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

Type declaration

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

`Readonly` execute

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

Type declaration

+
- (data?, name?, transferList?): Promise<Response>
- +
  Executes the specified function in the worker constructor with the task data input parameter.
  +
  +
  +
  Parameters
  +
  - +
    Optional data: Data
    +
    The optional task input data for the specified task function. This can only be structured-cloneable data.
    +
    +
  - +
    Optional name: string
    +
    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.
  -
  Returns
  Promise that will be resolved when the task is successfully completed.
  +

`Readonly` hasWorkerNodeBackPressure

hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)

Type declaration

+
- (workerNodeKey): boolean
- Internal +
  Whether the worker node has back pressure (i.e. its tasks queue is full).
  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:193

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

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

+
- (tasksQueueOptions): void
- +
  Sets the worker tasks queue options in this pool.
  +
  +
  +
  Parameters
  +
  - +
    tasksQueueOptions: TasksQueueOptions
    +
    The worker tasks queue options.
    +
    +
  +
  Returns void
  +

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