X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedThreadPool.html;h=38e5f6684eea18148b13d7f6344f3747957913aa;hb=b4c2a50df77a5f3110d228436ce9f3008cbd8297;hp=a4a272b70f3eca7faa11a45859de6cdf166d38a6;hpb=b881e803f1a32ce8d8218d3ba3638ad317ae87bc;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a4a272b7..38e5f668 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Options for this fixed thread pool.
-Emitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'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).Protected
Readonly
fileProtected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
Readonly
numberProtected
Readonly
optsProtected
promiseThe execution response promise map.
+ +The 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.Protected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
maxPool maximum size.
+The pool maximum size.
Protected
minPool minimum size.
+The pool minimum size.
Private
readyProtected
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Private
utilizationGets the approximate pool utilization.
+The approximate pool utilization.
The pool utilization.
Inherited from AbstractPool.utilization
Protected
workerGets the worker type.
+The worker type.
Overrides AbstractPool.worker
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -345,41 +360,38 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
Protected
afterProtected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +
Method hooked up after a worker node has been newly created. Can be overridden.
The newly created worker.
-The newly created worker node key.
+Inherited from AbstractPool.afterWorkerSetup
+Inherited from AbstractPool.afterWorkerNodeSetup
Protected
beforeThe worker node key.
-The task to execute.
-Inherited from AbstractPool.beforeTaskExecutionHook
Protected
checkInherited from AbstractPool.checkDynamicPoolSize
Protected
createProtected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up dynamic worker.
+New, completely set up dynamic worker node key.
Inherited from AbstractPool.createAndSetupDynamicWorker
+Inherited from AbstractPool.createAndSetupDynamicWorkerNode
Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
New, completely set up worker.
+New, completely set up worker node key.
Inherited from AbstractPool.createAndSetupWorker
+Inherited from AbstractPool.createAndSetupWorkerNode
Protected
createOverrides AbstractPool.createWorker
Terminates every current worker in this pool.
+Terminates all workers in this pool.
Inherited from AbstractPool.destroy
Protected
destroyProtected
destroyTerminates the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
+Overrides AbstractPool.destroyWorker
+Overrides AbstractPool.destroyWorkerNode
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-The worker node tasks queue options.
+Optional
Inherited from AbstractPool.enableTasksQueue
Executes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
-The optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
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.
+Optional
Promise that will be fulfilled when the task is completed.
Inherited from AbstractPool.execute
Protected
getProtected
flushGets the worker information from the given worker.
-The worker.
-The worker information.
- -https://nodejs.org/api/errors.html#class-error If the worker is not found.
-Inherited from AbstractPool.getWorkerInfoByWorker
+Inherited from AbstractPool.flushTasksQueue
Protected
getProtected
getGets the given worker its worker node key.
+Gets the worker information given its worker node key.
The worker.
+The worker node key.
+The worker information.
+ +Inherited from AbstractPool.getWorkerInfo
+The worker node key if found in the pool worker nodes, -1
otherwise.
The worker node key.
+true
if the worker node has back pressure, false
otherwise.
Inherited from AbstractPool.getWorkerNodeKey
+Inherited from AbstractPool.hasWorkerNodeBackPressure
Protected
internalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Worker nodes busyness boolean status.
Inherited from AbstractPool.internalBusy
Protected
isOverrides 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
registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
-The worker node key.
+The message listener callback.
Overrides AbstractPool.registerWorkerMessageListener
Protected
sendInherited from AbstractPool.sendKillMessageToWorker
+Protected
sendSends the startup message to the given worker.
+Sends the startup message to worker given its worker node key.
The worker which should receive the startup message.
-The worker node key.
+Overrides AbstractPool.sendStartupMessageToWorker
Protected
sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
-The worker node key.
+The message.
-Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Optional
Overrides AbstractPool.sendToWorker
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-The worker node tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Inherited from AbstractPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupInherited from AbstractPool.setupHook
Protected
workerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
@@ -791,7 +834,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Inherited from AbstractPool.workerListener
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Number of threads for this pool.
-