X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=5dff496fcdbe079d7bc3f674f45786369c13b47a;hb=e4b9c7f546318de7603566b141fd0e2d0118c794;hp=ca1b9c965dd6487ab40d972c3c1fc84b9e705609;hpb=fa6436344997918dbda3e94063b4c2e2e4a892c3;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index ca1b9c96..5dff496f 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 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
+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
workersInherited from AbstractPool.workers
+Readonly
workerPool worker nodes.
+Inherited from AbstractPool.workerNodes
Whether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Whether the pool is full or not.
+The pool filling boolean status.
+Overrides AbstractPool.full
Private
numberNumber of tasks queued in the pool.
+Inherited from AbstractPool.numberOfQueuedTasks
+Private
numberNumber of tasks concurrently running in the pool.
+Number of tasks running in the pool.
Inherited from AbstractPool.numberOfRunningTasks
Pool type.
+If it is 'dynamic'
, it provides the max
property.
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
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
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.
+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
+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
Shutdowns 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.findFreeWorkerKey
+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
Registers 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
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from AbstractPool.removeWorker
-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
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
+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
+Inherited from AbstractPool.workerListener
Generated using TypeDoc
Constructs a new poolifier fixed thread pool.