X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=a5f77512354de354d56ca7aaef2ae8b056d194af;hb=5decbf239157d04bdf38a642fe2757f565a8d466;hp=09fb7fa406096a103ebb639833008911509e28c6;hpb=bf4dcb92f8d370524a2975961731fe6c4e8b083c;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 09fb7fa4..a5f77512 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@
+'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Readonly
fileProtected
Readonly
fileReadonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
Readonly
optsProtected
Readonly
optsOptions for the pool.
Protected
promiseProtected
workerReadonly
workerProtected
fullWhether the pool is full or not.
The pool filling boolean status.
Private
numberProtected
maxNumber of tasks queued in the pool.
+Pool maximum size.
Private
numberProtected
minNumber of tasks running in the pool.
+Pool minimum size.
Protected
typePool type.
If it is 'dynamic'
, it provides the max
property.
Protected
workerGets the worker type.
+Overrides AbstractPool.worker
+The worker.
The received message.
Inherited from AbstractPool.afterTaskExecutionHook
Protected
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeInherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
[worker node key, worker node].
+The worker node key
Inherited from AbstractPool.chooseWorkerNode
Protected
createInherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Protected
destroyOverrides AbstractPool.destroyWorker
Inherited from AbstractPool.enableTasksQueue
Executes the function specified in the worker constructor with the task data input parameter.
+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 serializable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Promise that will be fulfilled when the task is completed.
Inherited from AbstractPool.execute
Protected
internalInherited from AbstractPool.internalBusy
Protected
isOverrides AbstractPool.isMain
Protected
registerOverrides AbstractPool.registerWorkerMessageListener
Protected
sendThe worker which should receive the message.
The message.
Overrides AbstractPool.sendToWorker
Inherited from AbstractPool.setTasksQueueOptions
The worker choice strategy.
Inherited from AbstractPool.setWorkerChoiceStrategy
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupInherited from AbstractPool.setupHook
Protected
workerThe listener function to execute when a message is received from a worker.
Inherited from AbstractPool.workerListener
Generated using TypeDoc
Path to the worker file.