X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=405c43bc4f1eda2ed96899097ca333e09c83ea99;hb=fd98bbb90c7202f5dd734c029f3cee2f997aea24;hp=bef39e3847e3106f8a001d2f57afe019e5cff9f1;hpb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index bef39e38..c2557b46 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Constructs a new poolifier fixed thread pool.
Number of threads for this pool.
-Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Options for this fixed thread pool.
-Overrides AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>.constructor
+Overrides AbstractPool.constructor
Optional
Readonly
emitterInherited from AbstractPool.emitter
-Readonly
filePath to the worker-file.
-Inherited from AbstractPool.filePath
-Readonly
numberOptional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Inherited from AbstractPool.emitter
+Protected
Readonly
filePath to the worker file.
+Inherited from AbstractPool.filePath
+Protected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Inherited from AbstractPool.max
+Protected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from AbstractPool.numberOfWorkers
-Readonly
optsOptions for the pool.
-Inherited from AbstractPool.opts
-Protected
promiseThe execution response promise map.
+Inherited from AbstractPool.numberOfWorkers
+Protected
Readonly
optsOptions for this fixed thread pool.
+Inherited from AbstractPool.opts
+Protected
promiseThe task execution response promise map.
key
: The message id of each submitted task.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 id.
-Inherited from AbstractPool.promiseResponseMap
+Inherited from AbstractPool.promiseResponseMap
Protected
workerProtected
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
+ +Inherited from AbstractPool.workerChoiceStrategyContext
+Readonly
Internal
workerPool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullOverrides AbstractPool.full
-Private
numberWhether the pool is full or not.
+The pool filling boolean status.
+Inherited from AbstractPool.full
+Number of tasks queued in the pool.
+Pool information.
Inherited from AbstractPool.numberOfQueuedTasks
-Private
numberInherited from AbstractPool.info
+Protected
maxNumber of tasks running in the pool.
+The pool maximum size.
Inherited from AbstractPool.numberOfRunningTasks
-Inherited from AbstractPool.maxSize
+Protected
minThe pool minimum size.
+Inherited from AbstractPool.minSize
+Private
readyThe pool readiness boolean status.
+Inherited from AbstractPool.ready
+Protected
typeThe pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Inherited from AbstractPool.utilization
+Protected
workerThe worker type.
+Overrides AbstractPool.worker
+Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -262,37 +363,45 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
-Protected
afterInherited from AbstractPool.afterTaskExecutionHook
+Protected
afterMethod hooked up after a worker node has been newly created. +Can be overridden.
+Overrides AbstractPool.afterWorkerSetup
-Protected
beforeThe newly created worker node key.
+Inherited from AbstractPool.afterWorkerNodeSetup
+Protected
beforeHook executed before the worker task execution. Can be overridden.
@@ -301,238 +410,475 @@ Can be overridden.The worker node key.
-The task to execute.
+Inherited from AbstractPool.beforeTaskExecutionHook
+Protected
checkInherited from AbstractPool.beforeTaskExecutionHook
+Inherited from AbstractPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
+Creates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
-[worker node key, worker node].
+Inherited from AbstractPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
Inherited from AbstractPool.chooseWorkerNode
-Protected
createNew, completely set up worker node key.
+ +Inherited from AbstractPool.createAndSetupWorkerNode
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new worker.
+Newly created worker.
-New, completely set up worker.
+Overrides AbstractPool.createWorker
+Terminates all workers in this pool.
Inherited from AbstractPool.createAndSetupWorker
-Protected
createInherited from AbstractPool.destroy
+Protected
destroyOverrides AbstractPool.createWorker
-Terminates the worker node given its worker node key.
+The worker node key.
+Overrides AbstractPool.destroyWorkerNode
+Inherited from AbstractPool.destroy
-Enables/disables the worker node tasks queue in this pool.
+Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+Executes the specified function in the worker constructor with the task data input parameter.
+Overrides AbstractPool.destroyWorker
-Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from AbstractPool.execute
+Protected
flushInherited from AbstractPool.flushTasksQueue
Protected
getInherited from AbstractPool.findFreeWorkerNodeKey
-Protected
internalGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Inherited from AbstractPool.getWorkerInfo
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+The worker node key.
+true
if the worker node has back pressure, false
otherwise.
Inherited from AbstractPool.hasWorkerNodeBackPressure
+Protected
internalInherited from AbstractPool.internalBusy
-Protected
isWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from AbstractPool.internalBusy
+Protected
isOverrides AbstractPool.isMain
-Should return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Lists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from AbstractPool.listTaskFunctions
+Protected
registerThe worker node key.
+The message listener callback.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
sendOverrides AbstractPool.registerWorkerMessageListener
+Protected
sendOverrides AbstractPool.sendToWorker
-Inherited from AbstractPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+Inherited from AbstractPool.setWorkerChoiceStrategy
-Protected
setupOverrides AbstractPool.sendStartupMessageToWorker
+Protected
sendSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Sends a message to worker given its worker node key.
Inherited from AbstractPool.setupHook
-Protected
workerThe worker node key.
+The message.
+Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Overrides AbstractPool.sendToWorker
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
+Sets the worker node tasks queue options in this pool.
+The worker node tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
+Inherited from AbstractPool.setupHook
+Protected
workerThis method 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.
- -The listener function to execute when a message is received from a worker.
+This method is the listener registered for each worker message.
Inherited from AbstractPool.workerListener
+The listener function to execute when a message is received from a worker.
+ +Inherited from AbstractPool.workerListener
Generated using TypeDoc
A thread pool with a fixed number of threads.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the threads in a round robin fashion.
- -Author
Alessandro Pio Ardizio
+Author
Alessandro Pio Ardizio
-Since
0.0.1
+Since
0.0.1