X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=ae34f527d938c417ca34dfdb07def1ef26d6ab7f;hb=afa30fd0dd5bbc5d305cc30be663966a449efc08;hp=77cdcd29be25504d72f3344b91605c6c7ea39394;hpb=1938bc376fa92d0c773c4c23b0305291ab483e6c;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 77cdcd29..ae34f527 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be serializable data.
+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.
Options for this dynamic cluster pool.
-Optional
Readonly
emitter{@inheritDoc}
-Protected
Readonly
maxMaximum number of workers that can be created by this pool.
-Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from FixedClusterPool.numberOfWorkers
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from FixedClusterPool.opts
Protected
promiseThe promise response map.
+Protected
promiseThe execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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 with the promise resolve/reject bound to 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.promiseResponseMap
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
+Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workers
+Readonly
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Protected
busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Overrides FixedClusterPool.busy
Protected
full{@inheritDoc}
+Whether the pool is full or not.
+The pool filling boolean status.
Inherited from FixedClusterPool.numberOfRunningTasks
-Inherited from FixedClusterPool.full
+{@inheritDoc}
+Pool information.
Inherited from FixedClusterPool.info
+Protected
maxPool maximum size.
+Overrides FixedClusterPool.maxSize
+Protected
minPool minimum size.
+Inherited from FixedClusterPool.minSize
+Protected
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Protected
workerGets the worker type.
+Inherited from FixedClusterPool.worker
+Protected
afterProtected
afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The worker.
-The received message.
-Inherited from FixedClusterPool.afterPromiseResponseHook
-Protected
afterInherited 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 key.
-Inherited from FixedClusterPool.beforePromiseResponseHook
-Protected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -[worker key, worker].
+The worker node key.
Inherited from FixedClusterPool.chooseWorker
-Protected
createInherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
chooseCreates a new worker for this pool and sets it up completely.
+Chooses a worker node for the next task.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
+The worker node key
-New, completely set up worker.
+Inherited from FixedClusterPool.chooseWorkerNode
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
+ +Inherited from FixedClusterPool.createAndSetupWorker
Protected
createProtected
create{@inheritDoc}
+Returns a newly created worker.
Inherited from FixedClusterPool.createWorker
{@inheritDoc}
+Shutdowns every current worker in this pool.
Inherited from FixedClusterPool.destroy
Protected
destroy{@inheritDoc}
+Shutdowns the given worker.
A worker within workerNodes
.
Inherited from FixedClusterPool.destroyWorker
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Inherited from FixedClusterPool.execute
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+{@inheritDoc}
+Executes 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.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Inherited from FixedClusterPool.findFreeWorkerKey
+Promise that will be fulfilled when the task is completed.
+ +Inherited from FixedClusterPool.execute
Protected
internalProtected
internalInherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
Protected
isProtected
is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Inherited from FixedClusterPool.isMain
Protected
register{@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
removeProtected
sendRemoves the given worker from the pool.
+Sends a message to the given worker.
The worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
-Protected
sendThe worker which should receive the message.
+The message.
+Inherited from FixedClusterPool.sendToWorker
+{@inheritDoc}
+Sets the worker tasks queue options in this pool.
Inherited from FixedClusterPool.sendToWorker
-The worker tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+{@inheritDoc}
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setup{@inheritDoc}
+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
workerProtected
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
.Author
Christopher Quadflieg
+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
+Since
2.0.0