X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=a02b125a6471ad45875d111e4d8eaf14bed4b993;hb=74f29142ea20199700ef7021402616ea9de714a8;hp=3d80e16254ca092efbd26def002b236ec569342f;hpb=e1230e386080ae19766e2a7863c807a90f13a3ef;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 3d80e162..a02b125a 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@
+Optional
Readonly
emitterReadonly
fileInherited from AbstractPool.filePath
Protected
nextId of the next message.
-Inherited from AbstractPool.nextMessageId
-Readonly
numberInherited from AbstractPool.numberOfWorkers
Readonly
optsInherited 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
workers{@inheritDoc}
-Inherited from AbstractPool.workers
-Readonly
workers{@inheritDoc}
-Inherited from AbstractPool.workersTasksUsage
+Readonly
workerInherited from AbstractPool.workerNodes
{@inheritDoc}
-Overrides AbstractPool.busy
Overrides AbstractPool.full
+Private
numberNumber of tasks queued in the pool.
+Inherited from AbstractPool.numberOfQueuedTasks
+Private
number{@inheritDoc}
+Number of tasks running in the pool.
Inherited from AbstractPool.numberOfRunningTasks
{@inheritDoc}
-Overrides AbstractPool.type
Protected
afterProtected
afterHook executed after the worker task promise resolution. Can be overridden.
@@ -260,24 +268,24 @@ Can be overridden.The received message.
+The worker.
The Promise response.
+The received message.
Inherited from AbstractPool.afterPromiseWorkerResponseHook
+Inherited from AbstractPool.afterPromiseResponseHook
Protected
after{@inheritDoc}
-Overrides AbstractPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. Can be overridden.
@@ -299,69 +307,83 @@ Can be overridden.The worker.
+The worker node key.
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+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.
+[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
Protected
dequeueInherited from AbstractPool.dequeueTask
+{@inheritDoc}
-Inherited from AbstractPool.destroy
{@inheritDoc}
-Overrides AbstractPool.destroyWorker
Protected
enqueueInherited from AbstractPool.enqueueTask
+{@inheritDoc}
-Inherited from AbstractPool.execute
{@inheritDoc}
-Inherited from AbstractPool.findFreeWorker
-{@inheritDoc}
-Inherited from AbstractPool.getWorkerAverageTasksRunTime
+Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
flush{@inheritDoc}
-Inherited from AbstractPool.getWorkerIndex
+Inherited from AbstractPool.flushTasksQueue
Protected
flush{@inheritDoc}
-Inherited from AbstractPool.getWorkerRunningTasks
+Inherited from AbstractPool.flushTasksQueueByWorker
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
is{@inheritDoc}
-Overrides AbstractPool.isMain
{@inheritDoc}
-Overrides AbstractPool.registerWorkerMessageListener
Protected
removeProtected
removeRemoves the given worker from the pool.
+Removes the given worker from the pool worker nodes.
The worker that will be removed.
+The worker.
Inherited from AbstractPool.removeWorker
+Inherited from AbstractPool.removeWorkerNode
Protected
send{@inheritDoc}
-Overrides AbstractPool.sendToWorker
{@inheritDoc}
-Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+Setup hook to run code before worker node are created in the abstract constructor. +Can be overridden
Inherited from AbstractPool.setupHook
Protected
tasksInherited from AbstractPool.tasksQueueLength
+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
{@inheritDoc}
-