AbstractPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=bbe344d91c32e9322c387af0a2be333376e07d1f;hb=f38f85c043864b68ea519f6bdf94821c356195f1;hp=d511387dbbebd301fc246fdb7819922b9de6bd6a;hpb=f45a3823ad04902b4c446c7c7de55ca183041953;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index d511387d..bbe344d9 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier

+AbstractPool | poolifier - v2.6.12

@@ -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:49

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

@@ -76,7 +77,10 @@ info maxSize minSize +ready +starting type +utilization worker

@@ -86,13 +90,16 @@ beforeTaskExecutionHook buildTasksQueueOptions checkAndEmitEvents +checkDynamicPoolSize checkFilePath +checkMessageWorkerId checkNumberOfWorkers checkPoolOptions checkValidTasksQueueOptions checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions -chooseWorkerNode +chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker dequeueTask @@ -104,24 +111,29 @@ executeTask flushTasksQueue flushTasksQueues +getWorkerById +getWorkerInfo getWorkerNodeKey +handleTaskExecutionResponse +handleWorkerReadyMessage internalBusy isMain pushWorkerNode -registerWorkerMessageListener +redistributeQueuedTasks +registerWorkerMessageListener removeWorkerNode sendToWorker setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNode -setWorkerNodeTasksUsage setWorkerStatistics setupHook +shallCreateDynamicWorker tasksQueueSize -updateEluTasksUsage -updateRunTimeTasksUsage -updateWaitTimeTasksUsage +updateEluWorkerUsage +updateRunTimeWorkerUsage +updateTaskStatisticsWorkerUsage +updateWaitTimeWorkerUsage workerListener

@@ -137,7 +149,7 @@

Type Parameters

-
Worker extends IWorker<Worker>

Worker extends IWorker

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

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

Properties

@@ -172,8 +184,9 @@

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.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'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.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

@@ -181,7 +194,7 @@

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

`Protected` `Readonly` filePath

filePath: string

@@ -189,7 +202,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -197,7 +210,7 @@

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

`Protected` `Readonly` opts

opts: PoolOptions<Worker>

@@ -205,7 +218,7 @@

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

`Protected` promiseResponseMap

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

@@ -218,25 +231,32 @@

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

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

@@ -250,7 +270,7 @@

Returns boolean

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

`Protected` full

Returns boolean

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

info

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

`Protected` `Abstract` maxSize

Returns number

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

`Protected` `Abstract` minSize

Returns number

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

`Private` ready

get ready(): boolean
+
Returns boolean
+
- Defined in src/pools/abstract-pool.ts:412

`Private` starting

get starting(): boolean
+
Returns boolean
+
- Defined in src/pools/abstract-pool.ts:404

`Protected` `Abstract` type

Returns "fixed" | "dynamic"

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

`Private` utilization

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

`Protected` `Abstract` worker

Returns "cluster" | "thread"

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

Methods

@@ -339,21 +387,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:683

`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
@@ -366,11 +414,11 @@ Can be overridden.

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

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

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution. Can be overridden.
@@ -382,11 +430,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:667

`Private` buildTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns TasksQueueOptions

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

`Private` checkAndEmitEvents

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

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

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:160

`Private` checkFilePath

filePath: string

Returns void

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

`Private` checkMessageWorkerId

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

`Private` checkNumberOfWorkers

numberOfWorkers: number

Returns void

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

`Private` checkPoolOptions

opts: PoolOptions<Worker>

Returns void

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

`Private` checkValidTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns void

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

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

`Private` checkValidWorkerChoiceStrategyOptions

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

`Protected` chooseWorkerNode

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

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

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

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

`Protected` createAndSetupWorker

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

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

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

`Private` dequeueTask

workerNodeKey: number

Returns undefined | Task<Data>

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

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

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

`Protected` `Abstract` destroyWorker

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

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

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

enableTasksQueue

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

`Private` enqueueTask

task: Task<Data>

Returns number

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

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.
@@ -631,7 +725,7 @@ Can be overridden.
Implementation of IPool.execute
- Defined in src/pools/abstract-pool.ts:383

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

`Private` executeTask

task: Task<Data>

Returns void

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

`Private` flushTasksQueue

workerNodeKey: number

Returns void

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

`Private` flushTasksQueues

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

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

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

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

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

`Private` handleTaskExecutionResponse

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

`Private` handleWorkerReadyMessage

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

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

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

`Protected` `Abstract` isMain

Returns boolean

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

`Private` pushWorkerNode

`Protected` `Abstract` registerWorkerMessageListener

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

`Private` redistributeQueuedTasks

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

`Private` registerWorkerMessageListener

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

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

Returns void

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

`Private` removeWorkerNode

Returns void

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

`Protected` `Abstract` sendToWorker

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

The message.

Returns void

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

setTasksQueueOptions

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

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

setWorkerChoiceStrategyOptions

`Private` setWorkerNode

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

`Private` setWorkerNodeTasksUsage

setWorkerNodeTasksUsage(workerNode, tasksUsage): 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
-
-
- Defined in src/pools/abstract-pool.ts:704

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

`Private` setWorkerStatistics

worker: Worker

Returns void

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

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

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

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

`Private` tasksQueueSize

workerNodeKey: number

Returns number

`Private` updateEluTasksUsage

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

`Private` updateEluWorkerUsage

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

Returns void

`Private` updateRunTimeTasksUsage

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

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

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

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

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file