AbstractPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4a702c21b1eeab59420a01ffa9169bf18e4916d7;hb=80520ca4c78c2a023bf78e96769317f7e1eeb6e5;hp=9283ff10c255dab55704f19a246c87e8453cabac;hpb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9283ff10..4a702c21 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier

+AbstractPool | poolifier - v2.6.15

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

IPool<Worker, Data, Response>

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

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

@@ -76,17 +77,23 @@ info maxSize minSize +ready +starting type +utilization worker

Methods

afterTaskExecutionHook +

addWorkerNode +afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook buildTasksQueueOptions checkAndEmitEvents +checkDynamicPoolSize checkFilePath +checkMessageWorkerId checkNumberOfWorkers checkPoolOptions checkValidTasksQueueOptions @@ -105,22 +112,24 @@ executeTask flushTasksQueue flushTasksQueues +getWorkerById +getWorkerInfo getWorkerNodeKey -getWorkerUsage +handleTaskExecutionResponse +handleWorkerReadyResponse internalBusy isMain -pushWorkerNode +redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker +sendWorkerStartupMessage setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNodeTasksUsage setWorkerStatistics setupHook shallCreateDynamicWorker -tasksMaxQueueSize tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -167,7 +176,7 @@

Returns AbstractPool<Worker, Data, Response>

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

Properties

@@ -176,8 +185,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.

@@ -185,7 +195,7 @@

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

`Protected` `Readonly` filePath

filePath: string

@@ -193,7 +203,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -201,7 +211,7 @@

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

`Protected` `Readonly` opts

opts: PoolOptions<Worker>

@@ -209,7 +219,7 @@

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

`Protected` promiseResponseMap

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

@@ -222,7 +232,15 @@

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

`Private` `Readonly` startTimestamp

startTimestamp: number

The start timestamp of the pool.

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -230,16 +248,16 @@

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

@@ -253,7 +271,7 @@

Returns boolean

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

`Protected` full

Returns boolean

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

info

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

`Protected` `Abstract` maxSize

Returns number

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

`Protected` `Abstract` minSize

Returns number

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

`Private` ready

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

`Private` starting

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

`Protected` `Abstract` type

Returns "fixed" | "dynamic"

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

`Private` utilization

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

`Protected` `Abstract` worker

Returns "cluster" | "thread"

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

Methods

`Private` addWorkerNode

addWorkerNode(worker): number
+
Adds the given worker in the pool worker nodes.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns number
The worker nodes length.
+ +
+
- Defined in src/pools/abstract-pool.ts:1152

`Protected` afterTaskExecutionHook

Returns void

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

`Protected` afterWorkerSetup

Returns void

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

`Protected` beforeTaskExecutionHook

Returns void

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

`Private` buildTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns TasksQueueOptions

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

`Private` checkAndEmitEvents

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

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

`Protected` checkDynamicPoolSize

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

`Private` checkFilePath

filePath: string

Returns void

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

`Private` checkMessageWorkerId

checkMessageWorkerId(message): void
+
Checks if the worker id sent in the received message from a worker is valid.
+
+
+
Parameters
+
- +
  message: MessageValue<Response, unknown>
  +
  The received message.
  +
  +
+
Returns void
+
+
Throws
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+
+
- Defined in src/pools/abstract-pool.ts:501

`Private` checkNumberOfWorkers

numberOfWorkers: number

Returns void

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

`Private` checkPoolOptions

opts: PoolOptions<Worker>

Returns void

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

`Private` checkValidTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns void

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

`Private` checkValidWorkerChoiceStrategy

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

`Private` checkValidWorkerChoiceStrategyOptions

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

`Private` dequeueTask

workerNodeKey: number

Returns undefined | Task<Data>

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

destroy

destroy(): Promise<void>
-
Terminate 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:449

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

`Protected` `Abstract` destroyWorker

Returns void | Promise<void>

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

enableTasksQueue

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

`Private` enqueueTask

task: Task<Data>

Returns number

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

execute

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

`Private` executeTask

executeTask(workerNodeKey, task): void
+
Executes the given task on the given worker.
+
Parameters
- workerNodeKey: number
- -
  task: Task<Data>
-
Returns void
+
task: Task<Data>
+
The task to execute.
+
+

Returns void

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

`Private` flushTasksQueue

workerNodeKey: number

Returns void

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

`Private` flushTasksQueues

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

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

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

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

`Private` getWorkerNodeKey

`Private` getWorkerUsage

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

`Private` handleTaskExecutionResponse

getWorkerUsage(workerNodeKey?): WorkerUsage
handleTaskExecutionResponse(message): void
Parameters
- -
  Optional workerNodeKey: number
-
Returns WorkerUsage
+
message: MessageValue<Response, unknown>

Returns void

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

`Private` handleWorkerReadyResponse

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

`Protected` internalBusy

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

`Protected` `Abstract` isMain

Returns boolean

`Private` pushWorkerNode

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

`Private` redistributeQueuedTasks

pushWorkerNode(worker): number
redistributeQueuedTasks(workerNodeKey): void
-
Pushes the given worker in the pool worker nodes.
-
Parameters
- -
  worker: Worker
  -
  The worker.
  -
  -
-
Returns number
The worker nodes length.
- -
+
workerNodeKey: number

Returns void

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

`Private` registerWorkerMessageListener

Returns void

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

`Private` removeWorkerNode

Returns void

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

`Protected` `Abstract` sendToWorker

Returns void

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

`Private` sendWorkerStartupMessage

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

`Private` setWorkerNodeTasksUsage

setWorkerNodeTasksUsage(workerNode, workerUsage): void
-
Sets the given worker node its tasks usage in the pool.
-
-
-
Parameters
-
- -
  workerNode: WorkerNode<Worker, Data>
  -
  The worker node.
  -
  -
- -
  workerUsage: WorkerUsage
  -
  The worker usage.
  -
  -
-
Returns void
-
-
- Defined in src/pools/abstract-pool.ts:813