X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=4f2f7601d3aa880074cb0851f3a67f06d97e51a5;hb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;hp=de57c48009493a1457e94d8ca14f4a08a5cccb09;hpb=2a7995b1242609d257b82b043ee772ee49f5c7ec;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index de57c480..4f2f7601 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
.emitter
.Author
Christopher Quadflieg
@@ -33,16 +33,16 @@ When the maximum number of workers is reached, an event is emitted. If you wantResponse = unknown
-Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -56,42 +56,41 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file Path
-max
-next Message Id
+max
number Of Workers
opts
-promise Map
+promise Response Map
worker Choice Strategy Context
-workers
-workers Tasks Usage
+worker Nodes
Properties
Accessors
-Methods
-constructor
-- new
Dynamic Cluster Pool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>
+- new
Dynamic Cluster Pool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>
-
@@ -130,43 +129,40 @@ When the maximum number of workers is reached, an event is emitted. If you want
Constructs a new poolifier dynamic cluster pool.
opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
Properties
Optional
Readonly
emitter{@inheritDoc}
+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.Inherited from FixedClusterPool.emitter
-- Defined in src/pools/abstract-pool.ts:40
Readonly
filePath to the worker-file.
+Path to the worker file.
Inherited from FixedClusterPool.filePath
-- Defined in src/pools/abstract-pool.ts:80
+Protected
Readonly
maxReadonly
maxMaximum number of workers that can be created by this pool.
-- Defined in src/pools/cluster/dynamic.ts:30
Message Id
-Protected
nextId of the next message.
-Inherited from FixedClusterPool.nextMessageId
--- Defined in src/pools/abstract-pool.ts:58
Readonly
numberInherited from FixedClusterPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:79
Readonly
optsInherited from FixedClusterPool.opts
-- Defined in src/pools/cluster/fixed.ts:53
Map
-Protected
promiseThe promise map.
+ Response Map
+Protected
promiseThe execution response promise map.
-
-
+
+
-key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
+When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Inherited from FixedClusterPool.promiseMap
+Inherited from FixedClusterPool.promiseResponseMap
-- Defined in src/pools/abstract-pool.ts:50
Choice Strategy Context
-Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Inherited from FixedClusterPool.workerChoiceStrategyContext
-- Defined in src/pools/abstract-pool.ts:65
-Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workers
--- Defined in src/pools/abstract-pool.ts:31
Tasks Usage
-Readonly
workers{@inheritDoc}
+ Nodes
+Readonly
workerPool worker nodes.
Inherited from FixedClusterPool.workersTasksUsage
+Inherited from FixedClusterPool.workerNodes
-- Defined in src/pools/abstract-pool.ts:34
Accessors
-busy
-+
+- get busy(): boolean
-
-
-
-
+
+
+
+
+
+- get numberOfRunningTasks(): number
-
-
+- Defined in src/pools/abstract-pool.ts:185
+Protected
busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Returns boolean
Overrides FixedClusterPool.busy
-- Defined in src/pools/cluster/dynamic.ts:43
number Of Running Tasks
-+- Defined in src/pools/cluster/dynamic.ts:48
+Protected
full+- get full(): boolean
+-
+
+
+
Whether the pool is full or not.
+The pool filling boolean status.
+Returns boolean
Overrides FixedClusterPool.full
++- Defined in src/pools/cluster/dynamic.ts:43
Of Queued Tasks
+Private
number+- get numberOfQueuedTasks(): number
+-
+
+
+
Number of tasks queued in the pool.
+Returns number
Inherited from FixedClusterPool.numberOfQueuedTasks
++- Defined in src/pools/abstract-pool.ts:195
Of Running Tasks
+Private
number{@inheritDoc}
+Number of tasks running in the pool.
Returns number
Inherited from FixedClusterPool.numberOfRunningTasks
-- Defined in src/pools/abstract-pool.ts:151
type
-- get type(): PoolType
+- get type(): PoolType
-
-
-
+
+- Defined in src/pools/cluster/dynamic.ts:38
-
+ Task Execution Hook
{@inheritDoc}
+Pool type.
+If it is
'dynamic'
, it provides themax
property.Returns PoolType
Returns PoolType
Overrides FixedClusterPool.type
-- Defined in src/pools/cluster/dynamic.ts:38
Methods
- Promise Worker Response Hook
+Protected
afterProtected
after-- after
Promise Worker Response Hook(message: MessageValue<Response, unknown>, promise: PromiseWorkerResponseWrapper<Worker, Response>): void
+- after
Task Execution Hook(worker: Worker, message: MessageValue<Response, unknown>): void
-
-
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:391
Worker Setup
- after
Worker Setup(worker: Worker): void
-
-
-
-
+
-
-- Defined in src/pools/cluster/fixed.ts:93
+
+ Task Execution Hook
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
Parameters
message: MessageValue<Response, unknown>
-The received message.
+worker: Worker
+The worker.
promise: PromiseWorkerResponseWrapper<Worker, Response>
-The Promise response.
+message: MessageValue<Response, unknown>
+The received message.
Returns void
Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
+Inherited from FixedClusterPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:266
Protected
after{@inheritDoc}
+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 themain-worker
<->worker
connection if not bind by default.Parameters
worker: Worker
worker: Worker
+The newly created worker.
+Returns void
Inherited from FixedClusterPool.afterWorkerSetup
-- Defined in src/pools/cluster/fixed.ts:93
Promise Worker Response Hook
+Protected
beforeProtected
before-- before
Promise Worker Response Hook(worker: Worker): void
+- before
Task Execution Hook(workerNodeKey: number): void
-
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:380
+
+ Worker Node
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
Returns void
Inherited from FixedClusterPool.beforePromiseWorkerResponseHook
+Inherited from FixedClusterPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:255
Worker
+Protected
chooseProtected
choose-- choose
Worker(): Worker
+- choose
Worker Node(): [number, WorkerNode<Worker, Data>]
-
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:424
And Setup Worker
- create
And Setup Worker(): Worker
-
-
+- Defined in src/pools/abstract-pool.ts:486
Worker
- create
Worker(): Worker
-
-
+- Defined in src/pools/cluster/fixed.ts:88
- destroy(): Promise<void>
-
-
-
-
+
+- destroy
Worker(worker: Worker): void
-
-
-
-
+
-
-- Defined in src/pools/cluster/fixed.ts:69
+
+
-
-- Defined in src/pools/abstract-pool.ts:254
+
+
-
-- Defined in src/pools/abstract-pool.ts:312
+
+
Chooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker node key, worker node].
Returns Worker
Inherited from FixedClusterPool.chooseWorker
+Returns [number, WorkerNode<Worker, Data>]
Inherited from FixedClusterPool.chooseWorkerNode
-- Defined in src/pools/abstract-pool.ts:293
Protected
createCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
Returns
New, completely set up worker.
Returns Worker
Inherited from FixedClusterPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:337
Protected
create{@inheritDoc}
+Returns a newly created worker.
Returns Worker
Inherited from FixedClusterPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:88
destroy
{@inheritDoc}
+Shutdowns every current worker in this pool.
Returns Promise<void>
Inherited from FixedClusterPool.destroy
-- Defined in src/pools/abstract-pool.ts:221
destroy Worker
-+- Defined in src/pools/abstract-pool.ts:343
Worker
+Protected
destroy{@inheritDoc}
+Shutdowns the given worker.
Parameters
worker: Worker
worker: Worker
+A worker within
+workerNodes
.Returns void
Inherited from FixedClusterPool.destroyWorker
-- Defined in src/pools/cluster/fixed.ts:69
execute
+enable Tasks Queue
-- execute(data: Data): Promise<Response>
+- enable
Tasks Queue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
-
-
-
-
-
-
-
-
-
-
+
+
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Parameters
data: Data
Returns Promise<Response>
Inherited from FixedClusterPool.execute
--- Defined in src/pools/abstract-pool.ts:205
find Free Worker
--- find
Free Worker(): false | Worker
--
-
-
-
{@inheritDoc}
-Returns false | Worker
Inherited from FixedClusterPool.findFreeWorker
--- Defined in src/pools/abstract-pool.ts:194
get Worker Average Tasks Run Time
--- get
Worker Average Tasks Run Time(worker: Worker): undefined | number
--
-
-
-
-
-
{@inheritDoc}
-Parameters
-+
-
-
enable: boolean
+Whether to enable or disable the worker tasks queue.
+worker: Worker
Returns undefined | number
Inherited from FixedClusterPool.getWorkerAverageTasksRunTime
+
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Returns void
Inherited from FixedClusterPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:166
get Worker Index
+execute
-- get
Worker Index(worker: Worker): number
+- execute(data: Data): Promise<Response>
-
-
-
-
-
-
+
+
{@inheritDoc}
+Executes the function specified in the constructor with the task data input parameter.
+ +Returns
Promise that will be resolved when the task is successfully completed.
Parameters
worker: Worker
Returns number
Inherited from FixedClusterPool.getWorkerIndex
+data: Data
+The task input data for the specified function. This can only be serializable data.
+Returns Promise<Response>
Inherited from FixedClusterPool.execute
-- Defined in src/pools/abstract-pool.ts:156
get Worker Running Tasks
+find Free Worker Node Key
-- get
Worker Running Tasks(worker: Worker): undefined | number
+- find
Free Worker Node Key(): number
-
-
-
-
-
-
+
-
-- Defined in src/pools/abstract-pool.ts:305
+
+ Busy
+- Defined in src/pools/abstract-pool.ts:300
Main
- is
Main(): boolean
-
-
-
-
+
+
-
-- Defined in src/pools/cluster/fixed.ts:80
+
+ To Worker
+
-
\ No newline at end of file
+
\ No newline at end of file
{@inheritDoc}
+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.Parameters
---
-
worker: Worker
Returns undefined | number
Inherited from FixedClusterPool.getWorkerRunningTasks
+Returns number
Inherited from FixedClusterPool.findFreeWorkerNodeKey
-- Defined in src/pools/abstract-pool.ts:161
Get Busy Status
+Protected
internalProtected
internal-- internal
Get Busy Status(): boolean
+- internal
Busy(): boolean
-
-
Returns boolean
Inherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:186
Protected
is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Returns boolean
Inherited from FixedClusterPool.isMain
-- Defined in src/pools/cluster/fixed.ts:64
register Worker Message Listener
--- register
Worker Message Listener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
+- Defined in src/pools/cluster/fixed.ts:64
Worker Message Listener
+Protected
register+- register
Worker Message Listener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
-
-
-
+
-
-
-
{@inheritDoc}
+Registers a listener callback on the given worker.
Type Parameters
@@ -492,103 +492,136 @@ Can be overridden.Parameters
worker: Worker
worker: Worker
+The worker which should register a listener.
+listener: ((message: MessageValue<Message, unknown>) => void)
+listener: ((message: MessageValue<Message, unknown>) => void)
+The message listener callback.
+-- (message: MessageValue<Message, unknown>): void
+- (message: MessageValue<Message, unknown>): void
-
-
-
+
Parameters
message: MessageValue<Message, unknown>
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.registerWorkerMessageListener
-- Defined in src/pools/cluster/fixed.ts:80
Worker
+Protected
removeProtected
send-- remove
Worker(worker: Worker): void
+- send
To Worker(worker: Worker, message: MessageValue<Data, unknown>): void
-
-
-
+-
+
-
-
-
+
+
+- Defined in src/pools/abstract-pool.ts:268
+- Defined in src/pools/abstract-pool.ts:218
+
+
Hook
- setup
Hook(): void
-
-
+- Defined in src/pools/cluster/fixed.ts:59
Listener
-
+- Defined in src/pools/abstract-pool.ts:509
+
+
-
-
-
+- constructor
+- emitter
+- file
Path
+- max
+- number
Of Workers
+- opts
+- promise
Response Map
+- worker
Choice Strategy Context
+- worker
Nodes
+- busy
+- full
+- number
Of Queued Tasks
+- number
Of Running Tasks
+- type
+- after
Task Execution Hook
+- after
Worker Setup
+- before
Task Execution Hook
+- choose
Worker Node
+- create
And Setup Worker
+- create
Worker
+- destroy
+- destroy
Worker
+- enable
Tasks Queue
+- execute
+- find
Free Worker Node Key
+- internal
Busy
+- is
Main
+- register
Worker Message Listener
+- send
To Worker
+- set
Tasks Queue Options
+- set
Worker Choice Strategy
+- set
Worker Choice Strategy Options
+- setup
Hook
+- worker
Listener
+
+
Removes the given worker from the pool.
+Sends a message to the given worker.
Parameters
worker: Worker
-The worker that will be removed.
+The worker which should receive the message.
+message: MessageValue<Data, unknown>
+The message.
Returns void
Inherited from FixedClusterPool.removeWorker
+Inherited from FixedClusterPool.sendToWorker
-- Defined in src/pools/abstract-pool.ts:280
To Worker
-Protected
send-- send
To Worker(worker: Worker, message: MessageValue<Data, unknown>): void
+- Defined in src/pools/cluster/fixed.ts:75
set Tasks Queue Options
++- set
Tasks Queue Options(tasksQueueOptions: TasksQueueOptions): void
-
-
-
-
--
-
+
-
{@inheritDoc}
+Sets the worker tasks queue options in this pool.
Parameters
worker: Worker
message: MessageValue<Data, unknown>
tasksQueueOptions: TasksQueueOptions
+The worker tasks queue options.
+Returns void
Inherited from FixedClusterPool.sendToWorker
+Inherited from FixedClusterPool.setTasksQueueOptions
-- Defined in src/pools/cluster/fixed.ts:75
set Worker Choice Strategy
-- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
-
-
-
-
+
+-
+
{@inheritDoc}
+Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+The worker choice strategy.
+
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:171
set Worker Choice Strategy Options
++- set
Worker Choice Strategy Options(workerChoiceStrategyOptions: WorkerChoiceStrategyOptions): void
+-
+
+
+
+
+
Sets the worker choice strategy options in this pool.
+Parameters
++-
+
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+The worker choice strategy options.
+Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
++- Defined in src/pools/abstract-pool.ts:244
Protected
setup{@inheritDoc}
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Returns void
Inherited from FixedClusterPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:59
Protected
worker-- worker
Listener(): ((message: MessageValue<Response, unknown>) => void)
+- worker
Listener(): ((message: MessageValue<Response, unknown>) => void)
-
-
--
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Returns ((message: MessageValue<Response, unknown>) => void)
+Returns ((message: MessageValue<Response, unknown>) => void)
-- (message: MessageValue<Response, unknown>): void
+- (message: MessageValue<Response, unknown>): void
-
-
@@ -596,15 +629,16 @@ Can be overridden.
-
-
+
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Parameters
message: MessageValue<Response, unknown>
message: MessageValue<Response, unknown>
Returns void
Inherited from FixedClusterPool.workerListener
-- Defined in src/pools/abstract-pool.ts:363
-
+Settings
Settings
Member Visibility
Theme
Generated using TypeDoc