X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=7806afafcb178b8bbc6d42415b006abc25d90b0a;hb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;hp=cc82e4d6bccebfee7371b17027b71782b4e7a3d7;hpb=842d8918a19fc2720d4436789a2e373bc623452e;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index cc82e4d6..7806afaf 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -
Type of execution response. This can only be serializable data.
+Constructs a new poolifier pool.
Number of workers that this pool should manage.
-Path to the worker-file.
-Path to the worker file.
+Options for the pool.
-Optional
Readonly
emitterOptional
Readonly
emitterEmitter 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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Implementation of IPool.emitter
Readonly
filePath to the worker-file.
-Readonly
numberProtected
Readonly
filePath to the worker file.
+Protected
Readonly
numberNumber of workers that this pool should manage.
-Readonly
optsProtected
Readonly
optsOptions for the pool.
-Protected
promiseProtected
promiseThe 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.
-Protected
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonly
workerReadonly
workerPool worker nodes.
-Implementation of IPool.workerNodes
Abstract
busyProtected
Abstract
busyWhether the pool is busy or not.
The pool busyness boolean status.
Abstract
fullProtected
fullWhether the pool is full or not.
The pool filling boolean status.
Private
numberNumber of tasks queued in the pool.
+Pool information.
Private
numberProtected
Abstract
maxNumber of tasks running in the pool.
+Pool maximum size.
Protected
Abstract
minPool minimum size.
+Abstract
typeProtected
Abstract
typePool type.
If it is 'dynamic'
, it provides the max
property.
Protected
Abstract
workerGets the worker type.
+Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -282,20 +337,23 @@ Can be overridden.The worker.
-The received message.
-Protected
Abstract
afterProtected
Abstract
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.
The newly created worker.
-Protected
beforeProtected
beforeHook executed before the worker task execution. Can be overridden.
@@ -322,355 +382,446 @@ Can be overridden.The worker node key.
-The task to execute.
+Private
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
choosePrivate
checkPrivate
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 tasks.
+The worker node key
-[worker node key, worker node].
+Protected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
New, completely set up dynamic worker.
+ +Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+ +Protected
Abstract
createProtected
Abstract
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Private
dequeuePrivate
dequeueShutdowns every current worker in this pool.
+Terminate every current worker in this pool.
Implementation of IPool.destroy
+Implementation of IPool.destroy
Protected
Abstract
destroyProtected
Abstract
destroyPrivate
enqueueEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Implementation of IPool.enableTasksQueue
+Private
enqueuePerforms the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Executes the specified function in the worker constructor with the task data input parameter.
The input for the specified task. This can only be serializable data.
-Implementation of IPool.execute
+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.
+ +Implementation of IPool.execute
Private
executePrivate
executeFinds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
A worker node key if there is one, -1
otherwise.
Implementation of IPool.findFreeWorkerNodeKey
-Private
flushPrivate
flushPrivate
flushPrivate
flushPrivate
getPrivate
getPrivate
getGets the given worker its worker node key.
- -The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
The worker.
-The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
Private
getPrivate
getGets the given worker its tasks usage in the pool.
- -The worker tasks usage.
-The worker.
-Protected
internalProtected
internalWhether worker nodes are executing at least one task.
+Worker nodes busyness boolean status.
+ +Protected
Abstract
isProtected
Abstract
isShould return whether the worker is the main worker or not.
Private
pushPrivate
pushPushes the given worker in the pool worker nodes.
- -The worker nodes length.
The worker.
-The worker nodes length.
+ +Protected
Abstract
registerProtected
Abstract
registerThe worker which should register a listener.
-The message listener callback.
Private
removePrivate
removeRemoves the given worker from the pool worker nodes.
The worker.
-Protected
Abstract
sendProtected
Abstract
sendSends a message to the given worker.
The worker which should receive the message.
-The message.
-Sets the worker choice strategy in this pool.
+Sets the worker tasks queue options in this pool.
The worker choice strategy.
-Implementation of IPool.setWorkerChoiceStrategy
+The worker tasks queue options.
+Implementation of IPool.setTasksQueueOptions
Private
setSets the given worker in the pool worker nodes.
+Sets the worker choice strategy in this pool.
The worker node key.
-The worker.
-The worker choice strategy.
+The worker tasks usage.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Implementation of IPool.setWorkerChoiceStrategy
+Sets the worker choice strategy options in this pool.
+The worker task queue.
-The worker choice strategy options.
+Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setPrivate
setSets the given worker node its tasks usage in the pool.
The worker node.
-The worker usage.
+Private
setThe worker node tasks usage.
-Protected
setupProtected
setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
Private
tasksPrivate
shallConditions for dynamic worker creation.
+Whether to create a dynamic worker or not.
+ +Private
tasksProtected
workerPrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
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.
The listener function to execute when a message is received from a worker.
+ + +Generated using TypeDoc
Base class that implements some shared logic for all poolifier pools.
-