X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=bef39e3847e3106f8a001d2f57afe019e5cff9f1;hb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;hp=b8b8bed349e41aaa607df34c3d98a569d456164c;hpb=79458fb6e10234a237757111e710f8f71424fa06;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b8b8bed3..bef39e38 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Options for this fixed thread pool.
Optional
Readonly
emitter{@inheritDoc}
-Inherited from AbstractPool.emitter
Readonly
fileInherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
Protected
promiseThe promise response map.
+The execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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 with the promise resolve/reject bound to 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.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
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. +
Hook executed after the worker task execution. Can be overridden.
The worker.
The received message.
Inherited from AbstractPool.afterPromiseResponseHook
+Inherited from AbstractPool.afterTaskExecutionHook
Protected
after{@inheritDoc}
-Overrides AbstractPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker key.
+The worker node key.
Inherited from AbstractPool.beforePromiseResponseHook
+Inherited from AbstractPool.beforeTaskExecutionHook
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
{@inheritDoc}
-Inherited from AbstractPool.destroy
{@inheritDoc}
-Overrides AbstractPool.destroyWorker
Inherited from AbstractPool.execute
{@inheritDoc}
-Inherited from AbstractPool.findFreeWorkerKey
+Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
is{@inheritDoc}
-Overrides AbstractPool.isMain
{@inheritDoc}
-Overrides AbstractPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from AbstractPool.removeWorker
-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 execute code before worker node are created in the abstract constructor. +Can be overridden
Inherited from 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
Generated using TypeDoc
Constructs a new poolifier fixed thread pool.