X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=412adcef0139d13b7d434269254326b602a2aad8;hb=0a1679ba0ec3a6ebc3400ca103612d0e106cde53;hp=297bbb751e4fad5b8275205b0b9509eb5eee4e30;hpb=74f29142ea20199700ef7021402616ea9de714a8;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 297bbb75..412adcef 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Constructs a new poolifier fixed cluster pool.
Number of workers for this pool.
Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this fixed cluster pool.
Overrides AbstractPool<Worker, Data, Response>.constructor
+Overrides AbstractPool.constructor
Optional
Readonly
emitterInherited from AbstractPool.emitter
+ +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.Inherited from AbstractPool.emitter
+Readonly
filePath to the worker-file.
+Path to the worker file.
Inherited from AbstractPool.filePath
+Inherited from AbstractPool.filePath
Readonly
numberNumber of workers that this pool should manage.
Inherited from AbstractPool.numberOfWorkers
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for this fixed cluster pool.
Inherited from AbstractPool.opts
+Inherited from AbstractPool.opts
Protected
promiseThe promise response map.
+ +The execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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.
+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
+Inherited from AbstractPool.promiseResponseMap
Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from AbstractPool.workerChoiceStrategyContext
+Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workerInherited from AbstractPool.workerNodes
+ +Pool worker nodes.
+Inherited from AbstractPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides AbstractPool.busy
Protected
fullWhether the pool is full or not.
+The pool filling boolean status.
+Overrides AbstractPool.full
Private
numberNumber of tasks queued in the pool.
@@ -231,10 +234,10 @@Inherited from AbstractPool.numberOfQueuedTasks
Private
numberNumber of tasks running in the pool.
@@ -242,391 +245,369 @@Inherited from AbstractPool.numberOfRunningTasks
Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Protected
afterProtected
afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The worker.
The received message.
Inherited from AbstractPool.afterPromiseResponseHook
+Inherited from AbstractPool.afterTaskExecutionHook
Protected
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.
+Overrides AbstractPool.afterWorkerSetup
+Overrides AbstractPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker node key.
Inherited from AbstractPool.beforePromiseResponseHook
+Inherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
Inherited from AbstractPool.chooseWorkerNode
+[worker node key, worker node].
+Inherited from AbstractPool.chooseWorkerNode
Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
Inherited from AbstractPool.createAndSetupWorker
+New, completely set up worker.
+Inherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
-Protected
dequeueInherited from AbstractPool.dequeueTask
+Returns a newly created worker.
+Overrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
-Shutdowns every current worker in this pool.
+Inherited from AbstractPool.destroy
+Protected
destroyOverrides AbstractPool.destroyWorker
+Overrides AbstractPool.destroyWorker
Protected
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.
+Inherited from AbstractPool.enqueueTask
+Inherited from AbstractPool.enableTasksQueue
Inherited from AbstractPool.execute
-Inherited from AbstractPool.findFreeWorkerNodeKey
-Protected
flushInherited from AbstractPool.flushTasksQueue
-Protected
flushExecutes the function specified in the worker constructor with the task data input parameter.
+Inherited from AbstractPool.flushTasksQueueByWorker
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Promise that will be fulfilled when the task is completed.
+Inherited from AbstractPool.execute
Protected
internalInherited from AbstractPool.internalBusy
+Inherited from AbstractPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Overrides AbstractPool.isMain
Protected
registerThe worker which should register a listener.
+The message listener callback.
+Overrides AbstractPool.registerWorkerMessageListener
+Overrides AbstractPool.registerWorkerMessageListener
Protected
removeProtected
sendRemoves the given worker from the pool worker nodes.
+Sends a message to the given worker.
The worker.
+The worker which should receive the message.
+The message.
Inherited from AbstractPool.removeWorkerNode
+Overrides AbstractPool.sendToWorker
Protected
sendSets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Overrides AbstractPool.sendToWorker
+Inherited from AbstractPool.setTasksQueueOptions
Sets the worker choice strategy in this pool.
+Inherited from AbstractPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Overrides AbstractPool.setupHook
+Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
tasksSets the worker choice strategy options in this pool.
+Inherited from AbstractPool.tasksQueueLength
+The worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
+Overrides AbstractPool.setupHook
+Protected
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.
Inherited from AbstractPool.workerListener
-The listener function to execute when a message is received from a worker.
+Inherited from AbstractPool.workerListener
+Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.