X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=0b232f29be2d00227a28ed520f67771f3a571334;hb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;hp=ae2dee91ef7358467f9e27618499248f7903b568;hpb=b4d61a7596f314145be453ddbcaa9b0dade39bfb;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index ae2dee91..0b232f29 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,6 +22,10 @@

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.

Hierarchy

IPool

Implemented by

AbstractPool

Defined in src/pools/pool.ts:117

@@ -42,15 +50,28 @@

Properties

destroy +

busy +destroy emitter? execute +findFreeWorkerNodeKey +full setWorkerChoiceStrategy +type +workerNodes

Properties

`Readonly` busy

busy: boolean

Whether the pool is busy or not.

The pool busyness boolean status.

destroy

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

Type declaration

@@ -63,27 +84,28 @@

Returns Promise<void>

Defined in src/pools/pool.ts:173

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

execute

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

Type declaration

- (data: Data): Promise<Response>
- (data: Data): Promise<Response>
- Performs the task specified in the constructor with the data parameter.
  @@ -93,12 +115,39 @@
  Parameters
  - -
    data: Data
    +
    data: Data
    
    The input for the specified task. This can only be serializable data.
  -
  Returns Promise<Response>

findFreeWorkerNodeKey

findFreeWorkerNodeKey: (() => number)

Type declaration

+
- (): number
- +
  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
  A worker node key if there is one, -1 otherwise.
  +
  +
  Returns number

Defined in src/pools/pool.ts:162

`Readonly` full

full: boolean

Whether the pool is full or not.

The pool filling boolean status.

setWorkerChoiceStrategy

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

@@ -107,7 +156,7 @@

- (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"): void
- Sets the worker choice strategy in this pool.
  
  @@ -120,11 +169,27 @@
Returns void