X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=596e0ce267c8527d32b838e8fe48c7fdc3ff956e;hb=d6b93f1ae5603949390418b787e0ad51b026f9c5;hp=a7b5b27c4ec19ee612dde0598367a1310d42d962;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a7b5b27c..596e0ce2 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Options for this fixed thread pool.
Optional
Readonly
emitterInherited from AbstractPool.emitter
+Emitter on which events can be listened to.
+Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Inherited from AbstractPool.emitter
+Readonly
filePath to the worker-file.
Inherited from AbstractPool.filePath
+Inherited from AbstractPool.filePath
Readonly
numberNumber of workers that this pool should manage.
Inherited from AbstractPool.numberOfWorkers
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for the pool.
Inherited from AbstractPool.opts
+Inherited from AbstractPool.opts
Protected
promiseThe execution response promise map.
key
: The message id of each submitted task.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
+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
+Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workerInherited from AbstractPool.workerNodes
+ +Pool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullWhether the pool is full or not.
+The pool filling boolean status.
+Overrides AbstractPool.full
Private
numberInherited from AbstractPool.numberOfQueuedTasks
Private
numberInherited from AbstractPool.numberOfRunningTasks
Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -266,29 +274,32 @@ Can be overridden.The worker.
The received message.
Inherited from AbstractPool.afterTaskExecutionHook
+Inherited from AbstractPool.afterTaskExecutionHook
Protected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
+Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
The newly created worker.
+Overrides AbstractPool.afterWorkerSetup
+Overrides AbstractPool.afterWorkerSetup
Protected
beforeThe worker node key.
Inherited from AbstractPool.beforeTaskExecutionHook
+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
+Inherited from AbstractPool.chooseWorkerNode
Protected
createNew, completely set up worker.
Inherited from AbstractPool.createAndSetupWorker
+Inherited from AbstractPool.createAndSetupWorker
Protected
createReturns a newly created worker.
+Overrides AbstractPool.createWorker
+Overrides AbstractPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from AbstractPool.destroy
+Inherited from AbstractPool.destroy
Protected
destroyShutdowns the given worker.
+A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+Overrides AbstractPool.destroyWorker
Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
+Inherited from AbstractPool.execute
+The input for the specified task. This can only be serializable data.
+Inherited from AbstractPool.execute
Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
A worker node key if there is one, -1
otherwise.
Inherited from AbstractPool.findFreeWorkerNodeKey
+Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
internalInherited from AbstractPool.internalBusy
+Inherited from AbstractPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Overrides AbstractPool.isMain
Protected
registerRegisters a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Overrides AbstractPool.registerWorkerMessageListener
+Overrides AbstractPool.registerWorkerMessageListener
Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Overrides AbstractPool.sendToWorker
+Overrides AbstractPool.sendToWorker
Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupInherited from AbstractPool.setupHook
+Inherited from AbstractPool.setupHook
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.
@@ -523,15 +554,16 @@ Can be overriddenInherited from AbstractPool.workerListener
+Inherited from AbstractPool.workerListener
Generated using TypeDoc
Constructs a new poolifier fixed thread pool.