X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=75415733c11ac7dd30a0e691c695148dea229af0;hb=a34454964733f585af19a04f21f9e35eb18c77b1;hp=7b890594753e7aef46f705fe2a7f97272eb35f96;hpb=0770fe626b2bb3212a1d73fa4764973ac92e241a;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 7b890594..75415733 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@
+Optional
Readonly
emitterReadonly
fileInherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
Protected
promiseInherited 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 +307,83 @@ 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
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.findFreeWorkerKey
+Inherited from AbstractPool.findFreeWorkerNodeKey
+Protected
flushInherited from AbstractPool.flushTasksQueue
Protected
flushInherited from AbstractPool.flushTasksQueueByWorker
+Protected
internalInherited 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}
-