X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=a206c71efbfc60a0aec7c21c6cc31ed391d65a4b;hb=e8dacfb2833a6682fad27f857b1127a1e04b2f04;hp=2249ac0fad1a469ad625069665fcd1df448062da;hpb=1d6ec394e8f7467f72baeb74dda4794fdc5ab322;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2249ac0f..a206c71e 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
2.0.0
Type of execution response. This can only be serializable 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.
Optional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
Inherited from AbstractPool.emitter
Readonly
filePath to the worker-file.
+Path to the worker file.
Inherited from AbstractPool.filePath
Readonly
numberNumber of workers that this pool should manage.
Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for this fixed cluster pool.
Inherited from AbstractPool.opts
Protected
promiseThe execution response promise map.
key
: The message id of each submitted task.Inherited from AbstractPool.promiseResponseMap
Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workerPool worker nodes.
Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
@@ -209,10 +212,10 @@Overrides AbstractPool.busy
Protected
fullWhether the pool is full or not.
@@ -221,10 +224,10 @@Overrides AbstractPool.full
Private
numberNumber of tasks queued in the pool.
@@ -232,10 +235,10 @@Inherited from AbstractPool.numberOfQueuedTasks
Private
numberNumber of tasks running in the pool.
@@ -243,25 +246,36 @@Inherited from AbstractPool.numberOfRunningTasks
Pool maximum size.
+Overrides AbstractPool.size
+Pool type.
If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -270,21 +284,21 @@ Can be overridden.The worker.
The received message.
Inherited 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 used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
The newly created worker.
Overrides AbstractPool.afterWorkerSetup
Protected
beforeHook executed before the worker task execution. Can be overridden.
@@ -312,66 +326,64 @@ Can be overridden.The worker node key.
Inherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
[worker node key, worker node].
+Inherited from AbstractPool.chooseWorkerNode
Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+Inherited from AbstractPool.createAndSetupWorker
Protected
createReturns a newly created worker.
Overrides AbstractPool.createWorker
Shutdowns every current worker in this pool.
Inherited from AbstractPool.destroy
Protected
destroyOverrides AbstractPool.destroyWorker
Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Inherited from AbstractPool.execute
+Inherited from AbstractPool.enableTasksQueue
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.
Executes the specified function in the worker constructor with the task data input parameter.
Inherited from AbstractPool.findFreeWorkerNodeKey
+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.
+Promise that will be fulfilled when the task is completed.
+Inherited from AbstractPool.execute
Protected
internalInherited from AbstractPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
Overrides AbstractPool.isMain
Protected
registerThe worker which should register a listener.
The message listener callback.
Overrides AbstractPool.registerWorkerMessageListener
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.
+The worker tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Inherited from AbstractPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -530,35 +592,33 @@ Can be overriddenOverrides 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.
The listener function to execute when a message is received from a worker.
+Inherited from AbstractPool.workerListener
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.