X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=c39833d6f625df14008bc65e241d9920158dd3b4;hb=d99ba5a8a292772965b5027272a8dc677a6ad008;hp=5e4adf05eeb4282930373887bdcaca42041520fa;hpb=fec1c97860619dd6356803fee392205474010d5b;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 5e4adf05..c39833d6 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,11 +1,13 @@
It is possible to perform tasks in sync or asynchronous mode as you prefer.
This pool selects the workers in a round robin fashion.
-of data sent to the worker. This can only be serializable data.
- -of response of execution. This can only be serializable data.
-2.0.0
@@ -30,9 +28,13 @@Type of response of execution. This can only be serializable data.
+Constructs a new poolifier fixed cluster pool.
Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Optional
opts: ClusterPoolOptions = {}Options for this fixed cluster pool.
Optional
Readonly
emitterReadonly
fileOptional
Readonly
maxProtected
nextId of the next message.
+Path to the worker-file.
Readonly
numberReadonly
optsOptions for this fixed cluster pool.
+Inherited from AbstractPool.opts
Protected
promiseThe promise map.
+Protected
promiseThe promise response 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 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.
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
workersInherited from AbstractPool.workers
Readonly
workersInherited from AbstractPool.workersTasksUsage
-Overrides AbstractPool.busy
Overrides AbstractPool.full
+Private
numberNumber of tasks concurrently running in the pool.
+Inherited from AbstractPool.numberOfRunningTasks
Overrides AbstractPool.type
Protected
afterProtected
afterHook executed after the worker task promise resolution. Can be overridden.
@@ -263,17 +251,17 @@ Can be overridden.The received message.
+The worker.
The Promise response.
+The received message.
Inherited from AbstractPool.afterPromiseWorkerResponseHook
+Inherited from AbstractPool.afterPromiseResponseHook
Protected
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. Can be overridden.
@@ -302,27 +290,27 @@ Can be overridden.The worker.
+The worker key.
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+Inherited from AbstractPool.beforePromiseResponseHook
Protected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+The default uses a round robin algorithm to distribute the load.
-Worker.
+[worker key, worker].
Inherited from AbstractPool.chooseWorker
Protected
createInherited 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
-Initializes tasks usage statistics.
-The worker.
-Inherited from AbstractPool.initWorkerTasksUsage
-Protected
internalInherited from AbstractPool.internalExecute
+Inherited from AbstractPool.findFreeWorkerKey
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
isOverrides AbstractPool.isMain
Overrides AbstractPool.registerWorkerMessageListener
Protected
removeWorker that will be removed.
+The worker that will be removed.
Inherited from AbstractPool.removeWorker
Protected
sendOverrides AbstractPool.sendToWorker
Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupOverrides AbstractPool.setupHook
Protected
workerInherited from AbstractPool.workerListener
Type of data sent to the worker. This can only be serializable data.
+