X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=f52bd444f7e096f06c75c0598f0f43c0e575ce1a;hb=c914a50e9996ca3f869c130974bff87b117f70f5;hp=5680e5ebfe5a5f3f34f1986a3d652760e6915f1d;hpb=bb3f9b66fa2241864d31937eeced22caab83d17e;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 5680e5eb..f52bd444 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Constructs a new poolifier fixed cluster pool.
Number of workers for this pool.
-Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this fixed cluster pool.
-Overrides AbstractPool<Worker, Data, Response>.constructor
+Overrides AbstractPool.constructor
Optional
Readonly
emitterInherited from AbstractPool.emitter
-Readonly
filePath to the worker-file.
-Inherited from AbstractPool.filePath
-Readonly
numberOptional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the maximum 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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Inherited from AbstractPool.emitter
+Protected
Readonly
filePath to the worker file.
+Inherited from AbstractPool.filePath
+Protected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from AbstractPool.numberOfWorkers
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from AbstractPool.opts
+ +Inherited from AbstractPool.opts
Protected
promiseProtected
promiseThe execution response promise map.
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 with the promise resolve/reject bound to the message id.
-Inherited from AbstractPool.promiseResponseMap
+ +Inherited from AbstractPool.promiseResponseMap
Protected
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from AbstractPool.workerChoiceStrategyContext
-Readonly
workerInherited from AbstractPool.workerNodes
+ +Inherited from AbstractPool.workerChoiceStrategyContext
+Readonly
workerPool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullWhether the pool is full or not.
+The pool filling boolean status.
+Inherited from AbstractPool.full
+Pool information.
+Inherited from AbstractPool.info
+Protected
maxPool maximum size.
+Overrides AbstractPool.maxSize
+Protected
minPool minimum size.
+Overrides AbstractPool.minSize
+Private
readyOverrides AbstractPool.full
+Inherited from AbstractPool.ready
Private
numberPrivate
startingNumber of tasks queued in the pool.
-Inherited from AbstractPool.numberOfQueuedTasks
+Inherited from AbstractPool.starting
Private
numberProtected
typeNumber of tasks running in the pool.
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Inherited from AbstractPool.numberOfRunningTasks
+Overrides AbstractPool.type
Private
utilizationOverrides AbstractPool.type
+Gets the approximate pool utilization.
+The pool utilization.
+ +Inherited from AbstractPool.utilization
+Protected
workerGets the worker type.
+Overrides AbstractPool.worker
Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -262,37 +351,45 @@ Can be overridden.The worker.
-The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
-Protected
afterInherited from AbstractPool.afterTaskExecutionHook
+Protected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
+Overrides AbstractPool.afterWorkerSetup
-Protected
beforeThe newly created worker.
+Inherited from AbstractPool.afterWorkerSetup
+Protected
beforeHook executed before the worker task execution. Can be overridden.
@@ -301,237 +398,319 @@ Can be overridden.The worker node key.
-The task to execute.
+Inherited from AbstractPool.beforeTaskExecutionHook
+Protected
checkInherited from AbstractPool.beforeTaskExecutionHook
+Inherited from AbstractPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Inherited from AbstractPool.chooseWorkerNode
-Protected
createNew, completely set up dynamic worker.
+ +Inherited from AbstractPool.createAndSetupDynamicWorker
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
Inherited from AbstractPool.createAndSetupWorker
-Protected
createNew, completely set up worker.
+ +Inherited from AbstractPool.createAndSetupWorker
+Protected
createOverrides AbstractPool.createWorker
-Creates a new worker.
+Newly created worker.
+ +Overrides AbstractPool.createWorker
+Inherited from AbstractPool.destroy
-Terminates every current worker in this pool.
+Inherited from AbstractPool.destroy
+Protected
destroyTerminates the given worker.
+Overrides AbstractPool.destroyWorker
-Overrides AbstractPool.destroyWorker
+Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.execute
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+Inherited from AbstractPool.findFreeWorkerNodeKey
-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 structured-cloneable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from AbstractPool.execute
+Protected
internalInherited from AbstractPool.internalBusy
-Protected
isWhether worker nodes are executing at least one task.
+Worker nodes busyness boolean status.
+ +Inherited from AbstractPool.internalBusy
+Protected
isOverrides AbstractPool.isMain
-Should return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Overrides AbstractPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
sendThe worker tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Overrides AbstractPool.sendToWorker
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+Sets the worker choice strategy options in this pool.
+Inherited from AbstractPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
+Protected
setupOverrides AbstractPool.setupHook
-Protected
workerSetup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
+Overrides AbstractPool.setupHook
+Protected
workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a 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 AbstractPool.workerListener
+The listener function to execute when a message is received from a worker.
+ + +Inherited from AbstractPool.workerListener
Generated using TypeDoc
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the workers in a round robin fashion.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0