X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=abeed306e2cc6cc3cb7787417145c354f18fbddc;hb=94ab998f44abe7ed2184a0702c45621b06f5641f;hp=6c8b461351fe597007ae467395a85e0ea1502703;hpb=fe9f25b5ac98c7c7fccd1849a200c5054a77cf03;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 6c8b4613..abeed306 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
Readonly
tasksInherited from AbstractPool.tasks
-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
Overrides AbstractPool.busy
Overrides AbstractPool.full
+Private
numberNumber of tasks concurrently running in the pool.
+Inherited from AbstractPool.numberOfRunningTasks
Overrides AbstractPool.type
Protected
afterHook executed after the worker task promise resolution. +Can be overridden.
+The worker.
+The received message.
+Inherited from AbstractPool.afterPromiseResponseHook
+Protected
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeHook executed before the worker task promise resolution. +Can be overridden.
+The worker key.
+Inherited from AbstractPool.beforePromiseResponseHook
+Protected
chooseChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker for the next task.
+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
Protected
decreaseDecrease the number of tasks that the given worker has applied.
-Worker whose tasks are decreased.
-Inherited from AbstractPool.decreaseWorkersTasks
-Inherited from AbstractPool.destroy
Overrides AbstractPool.destroyWorker
Inherited from AbstractPool.execute
Inherited from AbstractPool.findFreeWorker
-Inherited from AbstractPool.getWorkerIndex
-Inherited from AbstractPool.getWorkerRunningTasks
-Protected
increaseIncrease the number of tasks that the given worker has applied.
-Worker whose tasks are increased.
-Inherited from AbstractPool.increaseWorkersTask
-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.
+