X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d6e44aaa5dbac3bc8406be38c9a3951c5d51c281;hb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;hp=d23fd03171e76ad157f6497c40837d45a54a118e;hpb=4736ba628fabbf7e34e36ef0f55a96e86b7033ac;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d23fd031..d6e44aaa 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,114 +1,254 @@ -IPool | poolifier

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

Index

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:235

`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 concurrently their tasks quota.
'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 >= maximum queue size).

`Readonly` enableTasksQueue

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

Type declaration

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

execute

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

Defined in src/pools/pool.ts:266

`Readonly` execute

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

Type declaration

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

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

`Readonly` info

info: PoolInfo

Pool information.

setWorkerChoiceStrategy

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

Defined in src/pools/pool.ts:190

`Readonly` listTaskFunctions

listTaskFunctions: (() => string[])

Type declaration

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

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

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

`Readonly` setWorkerChoiceStrategy

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

Type declaration

+
- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Sets the worker choice strategy in this pool.
  
  @@ -116,41 +256,106 @@
  Parameters
  - -
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "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:248

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

`Readonly` `Internal` workerNodes

workerNodes: IWorkerNode<Worker, Data>[]

Pool worker nodes.

+ + - -

Generated using TypeDoc

\ No newline at end of file +

hasWorkerNodeBackPressure

info

listTaskFunctions

setTasksQueueOptions

setWorkerChoiceStrategy

setWorkerChoiceStrategyOptions

workerNodes

+ +

Generated using TypeDoc

\ No newline at end of file

Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Type Parameters

Data = unknown

Worker extends IWorker

Response = unknown

Data = unknown

Response = unknown

Hierarchy

Index

Index

Properties

Properties

destroy

Readonly destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

Optional Readonly emitter

Readonly enableTasksQueue

Type declaration

Parameters

enable: boolean

Optional tasksQueueOptions: TasksQueueOptions

Returns void

execute

Readonly execute

Type declaration

Parameters

Optional data: Data

Optional name: string

Optional transferList: TransferListItem[]

Returns Promise<Response>

Returns

Readonly hasWorkerNodeBackPressure

Type declaration

Parameters

data: Data

Returns Promise<Response>

Readonly info

setWorkerChoiceStrategy

Readonly listTaskFunctions

Type declaration

Returns string[]

Readonly setTasksQueueOptions

Type declaration

Parameters

tasksQueueOptions: TasksQueueOptions

Returns void

Readonly setWorkerChoiceStrategy

Type declaration

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Returns void

Readonly setWorkerChoiceStrategyOptions

Type declaration

Parameters

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

Readonly Internal workerNodes

Settings

Settings

Member Visibility

Theme

On This Page

`Readonly` destroy

`Optional` `Readonly` emitter

`Optional` `Readonly` emitter

`Readonly` enableTasksQueue

`Optional` tasksQueueOptions: TasksQueueOptions

`Readonly` execute

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Readonly` hasWorkerNodeBackPressure

`Readonly` info

`Readonly` listTaskFunctions

`Readonly` setTasksQueueOptions

`Readonly` setWorkerChoiceStrategy

`Readonly` setWorkerChoiceStrategyOptions

`Readonly` `Internal` workerNodes