X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0386e65b205229b799bc4793b2b3dddfe5c7d8bb;hb=842d8918a19fc2720d4436789a2e373bc623452e;hp=377ee16bca64dc2a58c874df7c8f62da61286908;hpb=f06d10306cf1bfffb90048cf6e96c8507cd0e916;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 377ee16b..0386e65b 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Protected
promiseThe promise 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
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
Readonly
workers{@inheritDoc}
+Readonly
workerPool worker nodes.
Inherited from FixedClusterPool.workers
+Inherited from FixedClusterPool.workerNodes
Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workersTasksUsage
-{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Overrides FixedClusterPool.busy
Whether the pool is full or not.
+The pool filling boolean status.
+Overrides FixedClusterPool.full
+Private
numberNumber of tasks queued in the pool.
+Inherited from FixedClusterPool.numberOfQueuedTasks
+Private
number{@inheritDoc}
+Number of tasks running in the pool.
Inherited from FixedClusterPool.numberOfRunningTasks
{@inheritDoc}
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Protected
afterProtected
afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
+The worker.
Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
+Inherited from FixedClusterPool.afterTaskExecutionHook
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 the main-worker
<->worker
connection if not bind by default.
The newly created worker.
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
+The worker node key.
Inherited from FixedClusterPool.beforePromiseWorkerResponseHook
+Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChooses 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.
-Worker.
+[worker node key, worker node].
Inherited from FixedClusterPool.chooseWorker
+Inherited from FixedClusterPool.chooseWorkerNode
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.
New, completely set up worker.
Inherited from FixedClusterPool.createAndSetupWorker
Protected
create{@inheritDoc}
+Returns a newly created worker.
Inherited from FixedClusterPool.createWorker
{@inheritDoc}
+Shutdowns every current worker in this pool.
Inherited from FixedClusterPool.destroy
{@inheritDoc}
+Shutdowns the given worker.
A worker within workerNodes
.
Inherited from FixedClusterPool.destroyWorker
{@inheritDoc}
+Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
The input for the specified task. This can only be serializable data.
+Inherited from FixedClusterPool.execute
{@inheritDoc}
-Inherited from FixedClusterPool.findFreeWorker
-{@inheritDoc}
-Inherited from FixedClusterPool.getWorkerAverageTasksRunTime
-{@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.
A worker node key if there is one, -1
otherwise.
Inherited from FixedClusterPool.getWorkerIndex
+Inherited from FixedClusterPool.findFreeWorkerNodeKey
{@inheritDoc}
-Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
internalProtected
internalInherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
Protected
is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Inherited from FixedClusterPool.isMain
{@inheritDoc}
+Registers a listener callback on the given worker.
The worker which should register a listener.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
-Protected
send{@inheritDoc}
+Sends a message to the given worker.
The worker which should receive the message.
+The message.
+Inherited from FixedClusterPool.sendToWorker
{@inheritDoc}
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setup{@inheritDoc}
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Inherited from FixedClusterPool.setupHook
Protected
workerThis function is the listener registered for each worker.
+This function is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
Inherited from FixedClusterPool.workerListener
Generated using TypeDoc
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
@@ -38,11 +38,11 @@ When the maximum number of workers is reached, an event is emitted. If you wantHierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -56,40 +56,36 @@ 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,20 +126,25 @@ 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
fileInherited 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