X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=5680e5ebfe5a5f3f34f1986a3d652760e6915f1d;hb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;hp=fe962139bfb6f81fa119ac3053a8f35d98a8b2e8;hpb=fb04552b8956b5f6b2dce0ce68cdfe27c798ae2f;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index fe962139..5680e5eb 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Options for this fixed cluster pool.
Inherited from AbstractPool.emitter
Readonly
fileInherited from AbstractPool.filePath
-Protected
nextId of the next message.
+Path to the worker-file.
Inherited from AbstractPool.nextMessageId
+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 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 AbstractPool.promiseMap
+Inherited from AbstractPool.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 AbstractPool.workerChoiceStrategyContext
Readonly
workersReadonly
workerInherited from AbstractPool.workers
+Inherited from AbstractPool.workerNodes
Readonly
workersInherited from AbstractPool.workersTasksUsage
-Overrides AbstractPool.busy
Overrides AbstractPool.full
+Private
numberNumber of tasks queued in the pool.
+Inherited from AbstractPool.numberOfQueuedTasks
+Private
numberNumber of tasks running in the pool.
+Inherited from AbstractPool.numberOfRunningTasks
Overrides AbstractPool.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.
The Promise response.
+The received message.
Inherited from AbstractPool.afterPromiseWorkerResponseHook
+Inherited from AbstractPool.afterTaskExecutionHook
Protected
afterOverrides AbstractPool.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 AbstractPool.beforePromiseWorkerResponseHook
+Inherited from AbstractPool.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 AbstractPool.chooseWorker
+Inherited from AbstractPool.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 AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Overrides AbstractPool.destroyWorker
Inherited from AbstractPool.execute
Inherited from AbstractPool.findFreeWorker
-Inherited from AbstractPool.getWorkerAverageTasksRunTime
-Inherited from AbstractPool.getWorkerIndex
-Inherited from AbstractPool.getWorkerRunningTasks
-Protected
internalInherited from AbstractPool.internalExecute
+Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
isOverrides AbstractPool.isMain
Overrides AbstractPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from AbstractPool.removeWorker
-Protected
sendOverrides AbstractPool.sendToWorker
Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupOverrides AbstractPool.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 AbstractPool.workerListener
Generated using TypeDoc
Constructs a new poolifier fixed cluster pool.