X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedClusterPool.html;h=129160a1ea042c6bdbec37bdb05046a348e45c60;hb=71056a0ac555e096c1428d6341ef45c7980a6332;hp=297bbb751e4fad5b8275205b0b9509eb5eee4e30;hpb=ffc8d14415d44de881ee66ee60fc74da48084976;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 297bbb75..129160a1 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
-Readonly
filePath to the worker-file.
-Inherited from AbstractPool.filePath
-Readonly
numberOptional
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.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
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from AbstractPool.opts
+Inherited from AbstractPool.opts
Protected
promiseThe promise response map.
+Protected
promiseThe 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.
-Inherited from AbstractPool.promiseResponseMap
-Protected
workerWhen 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.
Default to a round robin algorithm.
-Inherited from AbstractPool.workerChoiceStrategyContext
-Readonly
workerInherited from AbstractPool.workerNodes
+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
fullOverrides AbstractPool.full
-Private
numberWhether the pool is full or not.
+The pool filling boolean status.
+Inherited from AbstractPool.full
+Number of tasks queued in the pool.
+Pool information.
Inherited from AbstractPool.numberOfQueuedTasks
-Private
numberInherited from AbstractPool.info
+Protected
maxNumber of tasks running in the pool.
+Pool maximum size.
Inherited from AbstractPool.numberOfRunningTasks
-Overrides AbstractPool.maxSize
+Protected
minPool minimum size.
+Overrides AbstractPool.minSize
+Protected
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Protected
workerGets the 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 worker.
-The received message.
-Inherited from AbstractPool.afterPromiseResponseHook
-Protected
afterInherited 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.
Overrides AbstractPool.afterWorkerSetup
-Protected
beforeThe newly created worker.
+Overrides AbstractPool.afterWorkerSetup
+Protected
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
-Protected
chooseInherited 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].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Inherited from AbstractPool.chooseWorkerNode
-Protected
createThe worker node key
+ +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
-Protected
createOverrides AbstractPool.createWorker
-Protected
dequeueNew, completely set up worker.
+ +Inherited from AbstractPool.createAndSetupWorker
+Protected
createInherited 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
destroyShutdowns the given worker.
+Overrides AbstractPool.destroyWorker
-Protected
enqueueA worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.enqueueTask
-Whether to enable or disable the worker tasks queue.
+Inherited from AbstractPool.execute
-Inherited from AbstractPool.findFreeWorkerNodeKey
-Protected
flushOptional
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.flushTasksQueue
-Protected
flushOptional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Inherited from AbstractPool.flushTasksQueueByWorker
-Protected
internalOptional
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
+Inherited from AbstractPool.internalBusy
Protected
isProtected
isOverrides AbstractPool.isMain
-Should return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Protected
registerThe worker which should register a listener.
+The message listener callback.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
removeOverrides AbstractPool.registerWorkerMessageListener
+Protected
sendRemoves the given worker from the pool worker nodes.
+Sends a message to the given worker.
The worker.
-Inherited from AbstractPool.removeWorkerNode
-Protected
sendThe worker which should receive the message.
+The message.
+Overrides AbstractPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Overrides AbstractPool.sendToWorker
-The worker tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+Inherited from AbstractPool.setWorkerChoiceStrategy
-Protected
setupOverrides AbstractPool.setupHook
-Protected
tasksThe worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategy
+Sets the worker choice strategy options in this pool.
+Inherited from AbstractPool.tasksQueueLength
-Protected
workerThe 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
A cluster pool with a fixed number of workers.
It is possible to perform tasks in sync or asynchronous mode as you prefer.
This pool selects the workers in a round robin fashion.
+