AbstractPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=dd00795b10401f16601b371247deeb36ccabdda3;hb=369d0a5139123c2b62260d5793b36097479b23a2;hp=bf67558965e87ec5bc4d2f7b7682f78b2cde7b5f;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index bf675589..dd00795b 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier

+AbstractPool | poolifier - v2.6.8

@@ -29,12 +29,12 @@

Data = unknown

Type of data sent to the worker. This can only be serializable data.

Type of data sent to the worker. This can only be structured-cloneable data.

Response = unknown

Type of execution response. This can only be serializable data.

Type of execution response. This can only be structured-cloneable data.

@@ -49,7 +49,7 @@

IPool<Worker, Data, Response>

Defined in src/pools/abstract-pool.ts:51

@@ -66,6 +66,7 @@ numberOfWorkers opts promiseResponseMap +startTimestamp workerChoiceStrategyContext workerNodes

@@ -77,6 +78,7 @@ maxSize minSize type +utilization worker

@@ -92,7 +94,8 @@ checkValidTasksQueueOptions checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions -chooseWorkerNode +chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker dequeueTask @@ -104,22 +107,34 @@ executeTask flushTasksQueue flushTasksQueues +getInitialWorkerInfo +getInitialWorkerUsage +getWorkerById +getWorkerId +getWorkerInfo getWorkerNodeKey +handleTaskExecutionResponse +handleWorkerStartedMessage internalBusy isMain pushWorkerNode -registerWorkerMessageListener +redistributeQueuedTasks +registerWorkerMessageListener removeWorkerNode sendToWorker setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNode setWorkerNodeTasksUsage +setWorkerStatistics setupHook +shallCreateDynamicWorker +tasksMaxQueueSize tasksQueueSize -updateRunTimeTasksUsage -updateWaitTimeTasksUsage +updateEluWorkerUsage +updateRunTimeWorkerUsage +updateTaskStatisticsWorkerUsage +updateWaitTimeWorkerUsage workerListener

@@ -135,7 +150,7 @@

Type Parameters

-
Worker extends IWorker<Worker>

Worker extends IWorker

Data = unknown
@@ -161,7 +176,7 @@
Returns AbstractPool<Worker, Data, Response>
- Defined in src/pools/abstract-pool.ts:80

Defined in src/pools/abstract-pool.ts:96

Properties

@@ -179,7 +194,7 @@

Defined in src/pools/abstract-pool.ts:60

`Protected` `Readonly` filePath

filePath: string

@@ -187,7 +202,7 @@

Defined in src/pools/abstract-pool.ts:98

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -195,7 +210,7 @@

Defined in src/pools/abstract-pool.ts:97

`Protected` `Readonly` opts

opts: PoolOptions<Worker>

@@ -203,7 +218,7 @@

Defined in src/pools/abstract-pool.ts:99

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...

@@ -216,16 +231,23 @@

Defined in src/pools/abstract-pool.ts:70

`Private` `Readonly` startTimestamp

startTimestamp: number

The start timestamp of the pool.

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

Defined in src/pools/abstract-pool.ts:78

`Readonly` workerNodes

workerNodes: WorkerNode<Worker, Data>[] = []

@@ -234,7 +256,7 @@

Defined in src/pools/abstract-pool.ts:57

Accessors

@@ -248,7 +270,7 @@

Returns boolean

Defined in src/pools/abstract-pool.ts:530

`Protected` full

Returns boolean

Defined in src/pools/abstract-pool.ts:521

info

Defined in src/pools/abstract-pool.ts:252

`Protected` `Abstract` maxSize

Returns number

Defined in src/pools/abstract-pool.ts:427

`Protected` `Abstract` minSize

Returns number

Defined in src/pools/abstract-pool.ts:422

`Protected` `Abstract` type

Returns "fixed" | "dynamic"

Defined in src/pools/abstract-pool.ts:412

`Private` utilization

get utilization(): number
+
Gets the approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
- Defined in src/pools/abstract-pool.ts:391

`Protected` `Abstract` worker

Returns "cluster" | "thread"

Defined in src/pools/abstract-pool.ts:417

Methods

@@ -337,21 +371,21 @@ Can be overridden.

message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, unknown>

The received message.

Returns void

Defined in src/pools/abstract-pool.ts:641

`Protected` `Abstract` afterWorkerSetup

`Protected` afterWorkerSetup

afterWorkerSetup(worker): void
-
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-
Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.
+
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
Parameters
@@ -364,11 +398,11 @@ Can be overridden.

Returns void
- Defined in src/pools/abstract-pool.ts:589

Defined in src/pools/abstract-pool.ts:869

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution. Can be overridden.
@@ -380,11 +414,16 @@ Can be overridden.

workerNodeKey: number

The worker node key.

+
+
task: Task<Data>
+
The task to execute.
+

Returns void

Defined in src/pools/abstract-pool.ts:625

`Private` buildTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns TasksQueueOptions

Defined in src/pools/abstract-pool.ts:508

`Private` checkAndEmitEvents

Returns void
- Defined in src/pools/abstract-pool.ts:663

Defined in src/pools/abstract-pool.ts:1028

`Private` checkFilePath

filePath: string

Returns void

Defined in src/pools/abstract-pool.ts:135

`Private` checkNumberOfWorkers

numberOfWorkers: number

Returns void

Defined in src/pools/abstract-pool.ts:144

`Private` checkPoolOptions

opts: PoolOptions<Worker>

Returns void

Defined in src/pools/abstract-pool.ts:162

`Private` checkValidTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns void

Defined in src/pools/abstract-pool.ts:227

`Private` checkValidWorkerChoiceStrategy

Parameters

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

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

Returns void

Defined in src/pools/abstract-pool.ts:189

`Private` checkValidWorkerChoiceStrategyOptions

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

`Protected` chooseWorkerNode

Defined in src/pools/abstract-pool.ts:199

`Private` chooseWorkerNode

chooseWorkerNode(): number
Chooses a worker node for the next task.
-
The default worker choice strategy uses a round robin algorithm to distribute the load.
+
The default worker choice strategy uses a round robin algorithm to distribute the tasks.

Returns number
The worker node key
- Defined in src/pools/abstract-pool.ts:532

Defined in src/pools/abstract-pool.ts:811

`Protected` createAndSetupDynamicWorker

createAndSetupDynamicWorker(): Worker
+
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+
+
Returns Worker
New, completely set up dynamic worker.
+ +
+
- Defined in src/pools/abstract-pool.ts:947

`Protected` createAndSetupWorker

Defined in src/pools/abstract-pool.ts:879

`Protected` `Abstract` createWorker

createWorker(): Worker
-
Returns a newly created worker.
+
Creates a new worker.

-
Returns Worker
+
Returns Worker
Newly created worker.
+
- Defined in src/pools/abstract-pool.ts:580

Defined in src/pools/abstract-pool.ts:861

`Private` dequeueTask

workerNodeKey: number

Returns undefined | Task<Data>

Defined in src/pools/abstract-pool.ts:1141

destroy

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

Returns Promise<void>
Implementation of IPool.destroy
- Defined in src/pools/abstract-pool.ts:415

Defined in src/pools/abstract-pool.ts:580

`Protected` `Abstract` destroyWorker

destroyWorker(worker): void | Promise<void>
-
Shutdowns the given worker.
+
Terminates the given worker.
Parameters
@@ -563,7 +615,7 @@ Can be overridden.

Returns void | Promise<void>
- Defined in src/pools/abstract-pool.ts:430

Defined in src/pools/abstract-pool.ts:601

enableTasksQueue

Defined in src/pools/abstract-pool.ts:486

`Private` enqueueTask

task: Task<Data>

Returns number

Defined in src/pools/abstract-pool.ts:1137

execute

Optional data: Data
-
The task input data for the specified worker function. This can only be serializable data.
+
The task input data for the specified worker function. This can only be structured-cloneable data.
@@ -629,7 +681,7 @@ Can be overridden.
Implementation of IPool.execute
- Defined in src/pools/abstract-pool.ts:380

Defined in src/pools/abstract-pool.ts:546

`Private` executeTask

task: Task<Data>

Returns void

Defined in src/pools/abstract-pool.ts:1132

`Private` flushTasksQueue

workerNodeKey: number

Returns void

Defined in src/pools/abstract-pool.ts:1153

`Private` flushTasksQueues

Returns void
- Defined in src/pools/abstract-pool.ts:775

Defined in src/pools/abstract-pool.ts:1163

`Private` getInitialWorkerInfo

getInitialWorkerInfo(worker): WorkerInfo
+
+
Parameters
+
- +
  worker: Worker
+
Returns WorkerInfo
+
- Defined in src/pools/abstract-pool.ts:1223

`Private` getInitialWorkerUsage

getInitialWorkerUsage(worker?): WorkerUsage
+
+
Parameters
+
- +
  Optional worker: Worker
+
Returns WorkerUsage
+
- Defined in src/pools/abstract-pool.ts:1181

`Private` getWorkerById

getWorkerById(workerId): undefined | Worker
+
Get the worker given its id.
+
+
+
Parameters
+
- +
  workerId: number
  +
  The worker id.
  +
  +
+
Returns undefined | Worker
The worker if found in the pool worker nodes, undefined otherwise.
+ +
+
- Defined in src/pools/abstract-pool.ts:435

`Private` getWorkerId

getWorkerId(worker): undefined | number
+
Gets the worker id.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns undefined | number
The worker id.
+ +
+
- Defined in src/pools/abstract-pool.ts:1087

`Private` getWorkerInfo

getWorkerInfo(workerNodeKey): WorkerInfo
+
Gets the worker information.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns WorkerInfo
+
+
- Defined in src/pools/abstract-pool.ts:1057

`Private` getWorkerNodeKey

The worker.

Returns number

The worker node key if the worker is found in the pool worker nodes, -1 otherwise.

Returns number

The worker node key if found in the pool worker nodes, -1 otherwise.

Defined in src/pools/abstract-pool.ts:446

`Private` handleTaskExecutionResponse

handleTaskExecutionResponse(message): void
+
+
Parameters
+
- +
  message: MessageValue<Response, unknown>
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:1001

`Private` handleWorkerStartedMessage

handleWorkerStartedMessage(message): void
+
+
Parameters
+
- +
  message: MessageValue<Response, unknown>
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:986

`Protected` internalBusy

internalBusy(): boolean
-
Returns boolean
+
Whether worker nodes are executing at least one task.
+
+
Returns boolean
Worker nodes busyness boolean status.
+ +
- Defined in src/pools/abstract-pool.ts:371

Defined in src/pools/abstract-pool.ts:537

`Protected` `Abstract` isMain

Returns boolean

Defined in src/pools/abstract-pool.ts:616

`Private` pushWorkerNode

`Protected` `Abstract` registerWorkerMessageListener

Defined in src/pools/abstract-pool.ts:1067

`Private` redistributeQueuedTasks

redistributeQueuedTasks(worker): void
+
+
Parameters
+
- +
  worker: Worker
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:914

`Private` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
Registers a listener callback on the given worker.
@@ -759,12 +939,12 @@ Can be overridden.

Parameters
- -
  message: MessageValue<Message, Worker | MessagePort>
+
message: MessageValue<Message, unknown>

Returns void

Defined in src/pools/abstract-pool.ts:849

`Private` removeWorkerNode

Returns void

Defined in src/pools/abstract-pool.ts:1124

`Protected` `Abstract` sendToWorker

-
message: MessageValue<Data, Worker | MessagePort>
+
message: MessageValue<Data, unknown>

The message.

Returns void

Defined in src/pools/abstract-pool.ts:838

setTasksQueueOptions

Defined in src/pools/abstract-pool.ts:498

setWorkerChoiceStrategy

Parameters

-
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_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.

Defined in src/pools/abstract-pool.ts:453

setWorkerChoiceStrategyOptions

`Private` setWorkerNode

Defined in src/pools/abstract-pool.ts:475

`Private` setWorkerNodeTasksUsage

setWorkerNode(workerNodeKey, worker, tasksUsage, tasksQueue): void
setWorkerNodeTasksUsage(workerNode, workerUsage): void
-
Sets the given worker in the pool worker nodes.
+
Sets the given worker node its tasks usage in the pool.
Parameters
- -
  workerNodeKey: number
  -
  The worker node key.
  -
  -
- -
  worker: Worker
  -
  The worker.
  -
  -
- -
  tasksUsage: TasksUsage
  -
  The worker tasks usage.
  +
  workerNode: WorkerNode<Worker, Data>
  +
  The worker node.
- -
  tasksQueue: Queue<Task<Data>>
  -
  The worker task queue.
  +
  workerUsage: WorkerUsage
  +
  The worker usage.
Returns void
- Defined in src/pools/abstract-pool.ts:721

`Private` setWorkerNodeTasksUsage

Defined in src/pools/abstract-pool.ts:1045

`Private` setWorkerStatistics

setWorkerNodeTasksUsage(workerNode, tasksUsage): void
setWorkerStatistics(worker): void
-
Sets the given worker node its tasks usage in the pool.
-
Parameters
- -
  workerNode: WorkerNode<Worker, Data>
  -
  The worker node.
  -
  -
- -
  tasksUsage: TasksUsage
  -
  The worker node tasks usage.
  -
  -
-
Returns void
-
+
worker: Worker

Returns void

Defined in src/pools/abstract-pool.ts:1169

`Protected` setupHook

setupHook(): void
-
Setup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+
Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.

Returns void
- Defined in src/pools/abstract-pool.ts:438

Defined in src/pools/abstract-pool.ts:609

`Private` shallCreateDynamicWorker

shallCreateDynamicWorker(): boolean
+
Conditions for dynamic worker creation.
+
+
Returns boolean
Whether to create a dynamic worker or not.
+ +
+
- Defined in src/pools/abstract-pool.ts:828

`Private` tasksMaxQueueSize

tasksMaxQueueSize(workerNodeKey): number
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns number
+
- Defined in src/pools/abstract-pool.ts:1149

`Private` tasksQueueSize

workerNodeKey: number

Returns number

`Private` updateRunTimeTasksUsage

Defined in src/pools/abstract-pool.ts:1145

`Private` updateEluWorkerUsage

updateEluWorkerUsage(workerUsage, message): void
+
+
Parameters
+
- +
  workerUsage: WorkerUsage
- +
  message: MessageValue<Response, unknown>
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:740

`Private` updateRunTimeWorkerUsage

updateRunTimeTasksUsage(workerTasksUsage, message): void
updateRunTimeWorkerUsage(workerUsage, message): void
Parameters
- -
  workerTasksUsage: TasksUsage
- -
  message: MessageValue<Response, Worker | MessagePort>
+
message: MessageValue<Response, unknown>

Returns void

`Private` updateWaitTimeTasksUsage

Defined in src/pools/abstract-pool.ts:664

`Private` updateTaskStatisticsWorkerUsage

updateWaitTimeTasksUsage(workerTasksUsage, message): void
updateTaskStatisticsWorkerUsage(workerUsage, message): void
Parameters
- -
  workerTasksUsage: TasksUsage
- -
  message: MessageValue<Response, Worker | MessagePort>
+
message: MessageValue<Response, unknown>

Returns void

`Private` updateWaitTimeWorkerUsage

updateWaitTimeWorkerUsage(workerUsage, task): void
+
+
Parameters
+
- +
  workerUsage: WorkerUsage
- +
  task: Task<Data>
Returns void
- Defined in src/pools/abstract-pool.ts:502

Defined in src/pools/abstract-pool.ts:702

`Protected` workerListener

Parameters

-
message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, unknown>

Returns void

The listener function to execute when a message is received from a worker.

Defined in src/pools/abstract-pool.ts:974

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file