X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicClusterPool.html;h=4b1e830ed146af5a1d5b6fb7b4440f82cb0eed33;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=80576199ce10c7c89f64b236a836a750f5a942bd;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 80576199..4b1e830e 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,15 @@ -
Constructs a new poolifier dynamic cluster pool.
Minimum number of workers which are always active.
Maximum number of workers that can be created by this pool.
Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Optional
opts: ClusterPoolOptions = {}Options for this dynamic cluster pool.
Optional
Readonly
emitterEmitter 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
Readonly
filePath to the worker file.
+Inherited from FixedClusterPool.filePath
Readonly
maxInherited from FixedClusterPool.max
-Protected
nextId of the next message.
+Maximum number of workers that can be created by this pool.
Inherited from FixedClusterPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedClusterPool.numberOfWorkers
Readonly
optsOptions for this fixed cluster pool.
+Inherited from FixedClusterPool.opts
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
-Readonly
tasksInherited from FixedClusterPool.tasks
-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
workersInherited from FixedClusterPool.workers
+Readonly
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedClusterPool.busy
Protected
fullWhether 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
numberNumber of tasks running in the pool.
+Inherited from FixedClusterPool.numberOfRunningTasks
Pool maximum size.
+Overrides FixedClusterPool.size
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Protected
afterProtected
afterHook executed after the worker task execution. +Can be overridden.
+The worker.
+The received message.
+Inherited from FixedClusterPool.afterWorkerSetup
-Protected
chooseChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
-Inherited from FixedClusterPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
-Inherited from FixedClusterPool.createAndSetupWorker
-Protected
createInherited from FixedClusterPool.createWorker
+Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
decreaseProtected
afterDecrease the number of tasks that the given worker has applied.
+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.
Worker whose tasks are decreased.
+The newly created worker.
Inherited from FixedClusterPool.decreaseWorkersTasks
-Inherited from FixedClusterPool.destroy
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeInherited from FixedClusterPool.destroyWorker
+Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseInherited from FixedClusterPool.execute
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
+[worker node key, worker node].
+Inherited from FixedClusterPool.chooseWorkerNode
Protected
createInherited from FixedClusterPool.findFreeWorker
-Creates a new worker and sets it up completely in the pool worker nodes.
+New, completely set up worker.
+Inherited from FixedClusterPool.createAndSetupWorker
+Protected
createInherited from FixedClusterPool.getWorkerIndex
+Returns a newly created worker.
+Inherited from FixedClusterPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from FixedClusterPool.destroy
+Protected
destroyShutdowns the given worker.
+Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
increaseInherited from FixedClusterPool.destroyWorker
+Increase the number of tasks that the given worker has applied.
+Enables/disables the worker tasks queue in this pool.
Worker whose tasks are increased.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Inherited from FixedClusterPool.increaseWorkersTask
+Inherited from FixedClusterPool.enableTasksQueue
Protected
internalExecutes the specified function in the worker constructor with the task data input parameter.
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Inherited from FixedClusterPool.internalExecute
-Protected
internalPromise that will be fulfilled when the task is completed.
+Inherited from FixedClusterPool.execute
+Protected
internalInherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Inherited from FixedClusterPool.isMain
Protected
registerThe worker which should register a listener.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeProtected
sendRemoves the given worker from the pool.
+Sends a message to the given worker.
Worker that will be removed.
+The worker which should receive the message.
+The message.
Inherited from FixedClusterPool.removeWorker
+Inherited from FixedClusterPool.sendToWorker
Protected
sendSets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Inherited from FixedClusterPool.sendToWorker
+Inherited from FixedClusterPool.setTasksQueueOptions
Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup 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.
- -The listener function to execute when a message is received from a 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.
- -The listener function to execute when a message is received from a 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
- -emitter
.Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
+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
.Author
Christopher Quadflieg
Since
2.0.0