X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=d626a13078bc4e47f2b438e7073fdcc85ca848df;hb=21402562176f7550bcd9ba620cf551972fca6e98;hp=d491a4d4600eb8faf26fd377aaee5e3c6fcdc709;hpb=ba92b02f642f229cb927ab526148f10107831471;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index d491a4d4..d626a130 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@
+Optional
Readonly
emitterReadonly
fileInherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
Protected
promiseThe promise response map.
+The 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 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
workers{@inheritDoc}
-Inherited from AbstractPool.workers
+Readonly
workerInherited from AbstractPool.workerNodes
{@inheritDoc}
-Overrides AbstractPool.busy
{@inheritDoc}
-Overrides AbstractPool.full
Private
numberNumber of tasks queued in the pool.
+Inherited from AbstractPool.numberOfQueuedTasks
+Private
numberNumber of tasks concurrently running.
+Number of tasks running in the pool.
Inherited from AbstractPool.numberOfRunningTasks
{@inheritDoc}
-Overrides AbstractPool.type
Inherited from AbstractPool.afterPromiseResponseHook
Protected
after{@inheritDoc}
-Overrides AbstractPool.afterWorkerSetup
Protected
beforeHook executed before the worker task promise resolution. Can be overridden.
@@ -290,69 +301,69 @@ Can be overridden.The worker key.
+The worker node key.
Inherited from AbstractPool.beforePromiseResponseHook
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 key, 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
create{@inheritDoc}
-Overrides AbstractPool.createWorker
{@inheritDoc}
-Inherited from AbstractPool.destroy
{@inheritDoc}
-Overrides AbstractPool.destroyWorker
{@inheritDoc}
-Inherited from AbstractPool.execute
{@inheritDoc}
-Inherited from AbstractPool.findFreeWorkerKey
+Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
internalInherited from AbstractPool.internalBusy
Protected
is{@inheritDoc}
-Overrides AbstractPool.isMain
{@inheritDoc}
-Overrides AbstractPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from AbstractPool.removeWorker
-Protected
send{@inheritDoc}
-Overrides AbstractPool.sendToWorker
{@inheritDoc}
-Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setup{@inheritDoc}
-Overrides 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
{@inheritDoc}
-