X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=9de28f0cfe4a3cb12fe5a6a8e64bc4609040dd88;hb=95d287d1625c80929657a9f217774c5c8f6668e7;hp=bf67558965e87ec5bc4d2f7b7682f78b2cde7b5f;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index bf675589..24d4fdcd 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Path to the worker file.
-Options for the pool.
-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.'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 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.Private
Readonly
startThe start timestamp of the pool.
+Private
startedWhether the pool is started or not.
+Private
Readonly
startingWhether the pool is starting or not.
+Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
Abstract
maxProtected
maxPool maximum size.
+The pool maximum size.
Protected
Abstract
minProtected
minPool minimum size.
+The pool minimum size.
Private
readyThe pool readiness boolean status.
+Protected
Abstract
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected
Abstract
workerGets the worker type.
+The worker type.
Private
addAdds the given worker in the pool worker nodes.
+The worker.
+The added worker node key.
+ +https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
+Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -332,43 +437,40 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Protected
Abstract
afterProtected
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.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
-The newly created worker node key.
+Protected
beforeThe task to execute.
+Private
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
checkPrivate
checkPrivate
checkChecks if the worker id sent in the received message from a worker is valid.
+The received message.
+https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Private
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
choosePrivate
chooseChooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+The default worker choice strategy uses a round robin algorithm to distribute the tasks.
The worker node key
+The chosen worker node key
Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up worker.
+New, completely set up dynamic worker node key.
+Protected
createProtected
Abstract
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Private
dequeueShutdowns every current worker in this pool.
+Terminates all workers in this pool.
Protected
Abstract
destroyProtected
Abstract
destroyShutdowns the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
+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
Private
enqueueExecutes 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.
-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.
Private
executeExecutes the given task on the worker given its worker node key.
+The worker node key.
+Private
flushProtected
flushPrivate
flushPrivate
getProtected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Private
getGets the given worker its worker node key.
The worker.
+The worker node key if found in the pool worker nodes, -1
otherwise.
Private
getThe worker node key if the worker is found in the pool worker nodes, -1
otherwise.
The worker id.
+The worker node key if the worker id is found in the pool worker nodes, -1
otherwise.
Private
handlePrivate
handlePrivate
hasProtected
internalProtected
Abstract
isPrivate
pushPushes the given worker in the pool worker nodes.
+Lists the names of task function available in this pool.
The names of task function available in this pool.
+ +Implementation of IPool.listTaskFunctions
+Private
redistributeProtected
Abstract
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.
Private
removeThe worker.
+Protected
sendProtected
Abstract
sendSends the startup message to worker given its worker node key.
The worker node key.
+Private
sendSends the statistics message to worker given its worker node key.
+The worker node key.
+Protected
Abstract
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
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.
+Implementation of IPool.setTasksQueueOptions
Private
setThe worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Implementation of IPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setProtected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
+Private
shallSets the given worker in the pool worker nodes.
+Conditions for dynamic worker creation.
Whether to create a dynamic worker or not.
+ +Private
shallThe worker node key.
-The worker.
-The worker tasks usage.
-The worker task queue.
-Private
setPrivate
shallSets the given worker node its tasks usage in the pool.
+Whether the worker node shall update its task function worker usage or not.
The worker node.
-The worker node tasks usage.
-The worker node key.
+true
if the worker node shall update its task function worker usage, false
otherwise.
Protected
setupPrivate
startSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
-Private
taskPrivate
tasksPrivate
updatePrivate
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
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.
@@ -1000,19 +1400,19 @@ Can be overriddenThis 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.
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
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.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -63,9 +63,13 @@emitter?
file Path
+max?
number Of Workers
opts
promise Response Map
+start Timestamp
+started
+starting
worker Choice Strategy Context
worker Nodes
Properties
Methods
-Type Parameters
Worker extends IWorker<Worker>
Worker extends IWorker
Data = unknown
numberOfWorkers: number
Number of workers that this pool should manage.
-