X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=e0337f6da7d7ce5d90ae9a370f853298812aa781;hb=812ad701baefad24cad2df8f9a60bf4d581d8697;hp=a02b125a6471ad45875d111e4d8eaf14bed4b993;hpb=ffc8d14415d44de881ee66ee60fc74da48084976;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a02b125a..e0337f6d 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Options for this fixed thread pool.
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 context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workerInherited from AbstractPool.workerNodes
Overrides AbstractPool.busy
Overrides AbstractPool.full
Private
numberInherited from AbstractPool.numberOfQueuedTasks
Private
numberInherited from AbstractPool.numberOfRunningTasks
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
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker node key.
Inherited from AbstractPool.beforePromiseResponseHook
+Inherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
[worker node key, worker node].
Inherited from AbstractPool.chooseWorkerNode
Protected
createInherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Protected
dequeueInherited from AbstractPool.dequeueTask
-Inherited from AbstractPool.destroy
Overrides AbstractPool.destroyWorker
Protected
enqueueInherited from AbstractPool.enqueueTask
-Inherited from AbstractPool.execute
Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
flushInherited from AbstractPool.flushTasksQueue
-Protected
flushInherited from AbstractPool.flushTasksQueueByWorker
-Protected
internalInherited from AbstractPool.internalBusy
Protected
isOverrides AbstractPool.isMain
Overrides AbstractPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool worker nodes.
-The worker.
-Inherited from AbstractPool.removeWorkerNode
-Protected
sendOverrides AbstractPool.sendToWorker
Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupSetup hook to run code before worker node 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
tasksInherited from AbstractPool.tasksQueueLength
-Protected
workerThis 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 message.
@@ -619,15 +523,16 @@ Can be overriddenInherited from AbstractPool.workerListener
Generated using TypeDoc
Constructs a new poolifier fixed thread pool.