AbstractPool | poolifier

@@ -49,19 +49,19 @@

IPool<Worker, Data, Response>

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

Index

busy full info maxSize @@ -87,7 +88,8 @@

Methods

addWorkerNode +

addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -95,19 +97,17 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -119,40 +119,54 @@ getWorkerInfo getWorkerNodeKeyByWorker getWorkerNodeKeyByWorkerId +handleBackPressureEvent +handleEmptyQueueEvent handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure +hasTaskFunction hasWorkerNodeBackPressure +initializeEventEmitter internalBusy isMain -listTaskFunctions +listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener registerWorkerMessageListener +removeTaskFunction removeWorkerNode sendKillMessageToWorker sendStartupMessageToWorker sendStatisticsMessageToWorker +sendTaskFunctionOperationToWorker +sendTaskFunctionOperationToWorkers sendToWorker -setTasksQueueMaxSize +setDefaultTaskFunction +setTaskStealing setTasksQueueOptions +setTasksQueueSize +setTasksStealingOnBackPressure setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker +shallExecuteTask shallUpdateTaskFunctionWorkerUsage -startPool +start tasksQueueSize -tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage +updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

Constructors

constructor

new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
@@ -188,19 +202,20 @@
Returns AbstractPool<Worker, Data, Response>
- Defined in src/pools/abstract-pool.ts:112

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

'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.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'destroy': Emitted when the pool is destroyed.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.
'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).

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

`Protected` `Readonly` filePath

filePath: string

@@ -217,7 +232,7 @@

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

`Protected` `Optional` `Readonly` max

max?: number

@@ -225,7 +240,7 @@

Methods

addTaskFunction

addTaskFunction(name, fn): Promise<boolean>
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
- +
  fn: TaskFunction<Data, Response>
  +
  The task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was added, false otherwise.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+ +
Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
+
+
Implementation of IPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:807

Index

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

constructor

Returns AbstractPool<Worker, Data, Response>

Properties

Optional Readonly emitter

Optional emitter

Protected Readonly filePath

Protected Optional Readonly max

Protected Readonly numberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Private Readonly startTimestamp

Private started

Private Readonly starting

Private starting

Private Readonly taskFunctions

Protected workerChoiceStrategyContext

Readonly Internal workerNodes

Accessors

Returns boolean

Protected full

Returns boolean

info

Protected maxSize

Returns number

Protected minSize

Returns number

Private ready

Returns boolean

Protected Abstract type

Returns "fixed" | "dynamic"

Private utilization

Protected Abstract worker

Returns "thread" | "cluster"

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Private addWorkerNode

Throws

Protected afterTaskExecutionHook

Returns void

Protected afterWorkerNodeSetup

Returns void

Protected beforeTaskExecutionHook

Returns void

Private buildTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns TasksQueueOptions

Private checkAndEmitDynamicWorkerCreationEvents

Returns void

Private checkAndEmitTaskExecutionEvents

Returns void

Private checkAndEmitTaskQueuingEvents

Returns void

Protected checkDynamicPoolSize

Parameters

min: number

max: number

Returns void

Private checkFilePath

Parameters

filePath: string

Returns void

Private checkMessageWorkerId

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Data | Response, unknown>

Throws

`Optional` `Readonly` emitter

`Optional` emitter

`Protected` `Readonly` filePath

`Protected` `Optional` `Readonly` max

`Protected` `Readonly` numberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Private` `Readonly` startTimestamp

`Private` started

`Private` `Readonly` starting

`Private` starting

`Private` `Readonly` taskFunctions

`Protected` workerChoiceStrategyContext

`Readonly` `Internal` workerNodes

`Protected` full

`Protected` maxSize

`Protected` minSize

`Private` ready

`Protected` `Abstract` type

`Private` utilization

`Protected` `Abstract` worker

`Private` addWorkerNode

`Protected` afterTaskExecutionHook

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Private` buildTasksQueueOptions

`Private` checkAndEmitDynamicWorkerCreationEvents

`Private` checkAndEmitTaskExecutionEvents

`Private` checkAndEmitTaskQueuingEvents

`Protected` checkDynamicPoolSize

`Private` checkFilePath

`Private` checkMessageWorkerId

`Private` checkNumberOfWorkers

`Private` checkPoolOptions

`Private` checkValidTasksQueueOptions

`Private` checkValidWorkerChoiceStrategy

`Private` checkValidWorkerChoiceStrategyOptions

`Private` chooseWorkerNode

`Protected` createAndSetupDynamicWorkerNode

`Protected` createAndSetupWorkerNode

`Protected` `Abstract` createWorker

`Private` deleteTaskFunctionWorkerUsages

`Private` dequeueTask

`Protected` `Abstract` deregisterWorkerMessageListener

`Protected` `Abstract` destroyWorkerNode

`Private` enqueueTask

`Private` executeTask

`Protected` flushTasksQueue

`Private` flushTasksQueues

`Protected` getWorkerInfo

`Private` getWorkerNodeKeyByWorker

`Private` getWorkerNodeKeyByWorkerId

`Private` `Readonly` handleBackPressureEvent

`Private` `Readonly` handleEmptyQueueEvent

`Private` handleTaskExecutionResponse