Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

@@ -20,48 +22,82 @@

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

Index

Methods

destroy -execute -setWorkerChoiceStrategy +

Properties

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

Methods

Properties

destroy

destroy(): Promise<void>

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

Type declaration

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

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

Defined in src/pools/pool.ts:58

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

'busy': Emitted when the pool is busy.

+ +

execute

execute(data: Data): Promise<Response>

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

Type declaration

+
- (data: Data): Promise<Response>
- -
  Perform the task specified in the constructor with the data parameter.
  +
  Performs the task specified in the constructor with the data parameter.
  
  Returns
  Promise that will be resolved when the task is successfully completed.
  
  @@ -69,33 +105,73 @@
  Parameters
  - -
    data: Data
    +
    data: Data
    
    The input for the specified task. This can only be serializable data.
  -
  Returns Promise<Response>
  +
  Returns Promise<Response>

Defined in src/pools/pool.ts:159

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

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void

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

Type declaration

+
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
- -
  Set the worker choice strategy in this pool.
  +
  Sets the worker choice strategy in this pool.
  Parameters
  - -
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
    +
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    
    The worker choice strategy.
  -
  Returns void
  +
  Returns void

`Readonly` type

type: PoolType

Pool type.

If it is 'dynamic', it provides the max property.

Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Hierarchy

Index

Methods

Properties

Methods

Properties

destroy

Type declaration

Returns Promise<void>

`Optional` `Readonly` emitter

execute

Type declaration

Returns

Parameters

data: Data

data: Data

Returns Promise<Response>

findFreeWorkerNodeKey

Type declaration

Returns

Returns number

setWorkerChoiceStrategy

Type declaration

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"

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

Returns void

`Readonly` type

`Readonly` workerNodes

Settings

Settings

Member Visibility

Theme

Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Hierarchy

Index

Methods

Properties

Methods

Properties

destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

execute

Type declaration

Returns

Parameters

data: Data

data: Data

Returns Promise<Response>

findFreeWorkerNodeKey

Type declaration

Returns

Returns number

setWorkerChoiceStrategy

Type declaration

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"

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

Returns void

Readonly type

Readonly workerNodes

Settings

Settings

Member Visibility

Theme

`Optional` `Readonly` emitter

`Readonly` type

`Readonly` workerNodes