X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedThreadPool.html;h=57265e609f7b34bbbea60218553d07ed0907f5fb;hb=aad1903193fc5973e6f879b10bb3ff1715d8261c;hp=a7ecfda3e67bffacf67e9574cc1dc26366e67807;hpb=797996a92f40d5779cd31314b59462e41d529989;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a7ecfda3..57265e60 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
-{@inheritDoc}
-Overrides AbstractPool.busy
Overrides AbstractPool.full
+Private
number{@inheritDoc}
+Number of tasks concurrently 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 +251,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,27 +290,27 @@ Can be overridden.The worker.
+The worker key.
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+Inherited from AbstractPool.beforePromiseResponseHook
Protected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+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
create{@inheritDoc}
-Overrides AbstractPool.createWorker
{@inheritDoc}
-Inherited from AbstractPool.destroy
{@inheritDoc}
-Overrides AbstractPool.destroyWorker
{@inheritDoc}
-Inherited from AbstractPool.execute
{@inheritDoc}
-Inherited from AbstractPool.findFreeWorker
-{@inheritDoc}
-Inherited from AbstractPool.getWorkerAverageTasksRunTime
-{@inheritDoc}
-Inherited from AbstractPool.getWorkerIndex
-{@inheritDoc}
-Inherited from AbstractPool.getWorkerRunningTasks
+Inherited from AbstractPool.findFreeWorkerKey
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
is{@inheritDoc}
-Overrides AbstractPool.isMain
{@inheritDoc}
-Overrides AbstractPool.registerWorkerMessageListener
Protected
removeInherited 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.
+to run code before workers are created in the abstract constructor. +Can be overriddenInherited from AbstractPool.setupHook
Protected
workerInherited from AbstractPool.workerListener
{@inheritDoc}
-