X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=f37b4d1b4fb7c3dc6e10aea342584d527f6e56c2;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=8ea3cf710b5237793d0e3cf4133d5eb57578ab14;hpb=ed1ecf09c599769ed61771ec25d71c39c19ba70b;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 8ea3cf71..9e8a6b1c 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,15 @@ -
Type of data sent to the worker. This can only be structured-cloneable 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.
Optional
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}Options for this fixed thread pool.
-Overrides AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>.constructor
+Overrides AbstractPool.constructor
Optional
Readonly
emitterInherited from AbstractPool.emitter
-Readonly
fileInherited from AbstractPool.filePath
-Optional
Readonly
maxInherited from AbstractPool.max
-Protected
nextId of the next message.
-Inherited from AbstractPool.nextMessageId
-Readonly
numberInherited from AbstractPool.numberOfWorkers
-Readonly
optsInherited from AbstractPool.opts
-Protected
promiseThe promise map.
-key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.Optional
Readonly
emitterEmitter 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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
-Inherited from AbstractPool.promiseMap
-Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Inherited from AbstractPool.workerChoiceStrategyContext
-Readonly
workersInherited from AbstractPool.workers
+Inherited from AbstractPool.emitter
+Protected
Readonly
filePath to the worker file.
+Inherited from AbstractPool.filePath
+Protected
Readonly
numberNumber of workers that this pool should manage.
+Inherited from AbstractPool.numberOfWorkers
Readonly
workersInherited from AbstractPool.workersTasksUsage
+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
+Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Inherited from AbstractPool.workerChoiceStrategyContext
+Readonly
workerPool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullInherited from AbstractPool.numberOfRunningTasks
-Whether the pool is full or not.
+The pool filling boolean status.
+Inherited from AbstractPool.full
+Pool information.
+Inherited from AbstractPool.info
+Protected
maxThe pool maximum size.
+Overrides AbstractPool.maxSize
+Protected
minThe pool minimum size.
+Overrides 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 promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker node key.
+The Promise response.
-Inherited from AbstractPool.afterPromiseWorkerResponseHook
-Protected
afterThe received message.
+Inherited 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 promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The task to execute.
+Inherited from AbstractPool.beforeTaskExecutionHook
+Protected
checkInherited from AbstractPool.beforePromiseWorkerResponseHook
+Inherited from AbstractPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Creates a new, completely set up dynamic worker node.
Inherited from AbstractPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
+New, completely set up dynamic worker node key.
-New, completely set up worker.
+Inherited from AbstractPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
Inherited from AbstractPool.createAndSetupWorker
-Protected
createNew, completely set up worker node key.
+ +Inherited from AbstractPool.createAndSetupWorkerNode
+Protected
createOverrides AbstractPool.createWorker
-Creates a new worker.
+Newly created worker.
+ +Overrides AbstractPool.createWorker
+Inherited from AbstractPool.destroy
-Terminates all workers in this pool.
+Inherited from AbstractPool.destroy
+Protected
destroyTerminates the worker node given its worker node key.
+Overrides AbstractPool.destroyWorker
-Overrides AbstractPool.destroyWorkerNode
+Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.execute
-Inherited from AbstractPool.findFreeWorker
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+Executes the specified function in the worker constructor with the task data input parameter.
+Inherited from AbstractPool.getWorkerAverageTasksRunTime
-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.getWorkerIndex
+Inherited from AbstractPool.flushTasksQueue
Protected
getGets the worker information given its worker node key.
+Inherited from AbstractPool.getWorkerRunningTasks
-The worker node key.
+The worker information.
+ +Inherited from AbstractPool.getWorkerInfo
+Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from AbstractPool.internalBusy
+Protected
isShould return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Initializes tasks usage statistics.
+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 worker given its worker node key.
+The worker.
-Inherited from AbstractPool.initWorkerTasksUsage
-Protected
internalThe worker node key.
+The message listener callback.
+Inherited from AbstractPool.internalExecute
-Protected
internalInherited from AbstractPool.internalGetBusyStatus
-Protected
isOverrides AbstractPool.isMain
-Overrides AbstractPool.registerWorkerMessageListener
+Protected
sendInherited from AbstractPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
removeThe worker node key.
+Overrides AbstractPool.sendStartupMessageToWorker
+Protected
sendRemoves the given worker from the pool.
+Sends a message to worker given its worker node key.
Worker that will be removed.
-Inherited from AbstractPool.removeWorker
-Protected
sendThe worker node key.
+The message.
+Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Overrides AbstractPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Overrides AbstractPool.sendToWorker
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+Sets the worker choice strategy options in this pool.
+Inherited from AbstractPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
+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 nodes are created in the abstract constructor. +Can be overridden.
Inherited from AbstractPool.setupHook
-Protected
workerInherited from AbstractPool.setupHook
+Protected
workerThis function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+This 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.
- -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.
- -Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
- -Author
Alessandro Pio Ardizio
+Author
Alessandro Pio Ardizio
-Since
0.0.1
+Since
0.0.1