X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=2249ac0fad1a469ad625069665fcd1df448062da;hb=f9b4bbf801547d7e17bf43e2e586ac956e97e1b0;hp=b8a6f3ee95084808665d650ade9e06d16f4f3dd2;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index b8a6f3ee..2249ac0f 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,15 @@ -
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
emitterInherited from AbstractPool.emitter
+Emitter on which events can be listened to.
+Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Inherited from AbstractPool.emitter
+Readonly
fileInherited from AbstractPool.filePath
-Optional
Readonly
maxInherited from AbstractPool.max
-Protected
nextId of the next message.
+Path to the worker-file.
Inherited from AbstractPool.nextMessageId
+Inherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
+Number of workers that this pool should manage.
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
+ +Options 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
-Readonly
tasksInherited from AbstractPool.tasks
+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
+Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workersInherited from AbstractPool.workers
+Readonly
workerPool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullWhether the pool is full or not.
+The pool filling boolean status.
+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
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.
+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
beforeOverrides AbstractPool.afterWorkerSetup
+Inherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChoose 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
+Inherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
-Protected
decreaseDecrease the number of tasks that the given worker has applied.
+Returns a newly created worker.
Worker whose tasks are decreased.
-Inherited from AbstractPool.decreaseWorkersTasks
+Overrides AbstractPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from AbstractPool.destroy
+Inherited from AbstractPool.destroy
Protected
destroyOverrides AbstractPool.destroyWorker
+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.
+Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
Worker whose tasks are increased.
+The input for the specified task. This can only be serializable data.
Inherited from AbstractPool.increaseWorkersTask
+Inherited from AbstractPool.execute
Protected
internalInherited from AbstractPool.internalExecute
+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.
Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Overrides AbstractPool.isMain
Protected
registerRegisters a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
removeRemoves the given worker from the pool.
-Worker that will be removed.
-Inherited from AbstractPool.removeWorker
+Overrides AbstractPool.registerWorkerMessageListener
Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Overrides AbstractPool.sendToWorker
+Overrides AbstractPool.sendToWorker
Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
+Overrides AbstractPool.setupHook
+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
+Inherited from AbstractPool.workerListener
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
+