X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=c17a4d099d0cdef2beedcda7b9fc0e2bc374f8ed;hb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;hp=b66a5d35120498c362f7c01bc547e59f82a6cbcd;hpb=8662ea71e523af81c1138618f0e12b89df35ce8a;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index b66a5d35..3f1be4eb 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,15 @@ -
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
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 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.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 cluster pool.
+Inherited from AbstractPool.opts
+Protected
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.
+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
maxPool maximum size.
+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 received message.
-The worker.
+The Promise response.
-Inherited from AbstractPool.afterPromiseWorkerResponseHook
-Protected
afterThe received message.
+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.
Overrides AbstractPool.afterWorkerSetup
-Protected
beforeOverrides AbstractPool.afterWorkerSetup
+Protected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-Inherited from AbstractPool.beforePromiseWorkerResponseHook
-Protected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+The worker node key.
Inherited from AbstractPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+ +The task to execute.
Inherited from AbstractPool.createAndSetupWorker
-Protected
createOverrides AbstractPool.createWorker
-Inherited from AbstractPool.destroy
-Inherited from AbstractPool.beforeTaskExecutionHook
+Protected
createOverrides AbstractPool.destroyWorker
-Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+New, completely set up dynamic worker.
+ +Inherited from AbstractPool.createAndSetupDynamicWorker
+Protected
createInherited from AbstractPool.execute
-Creates a new worker and sets it up completely in the pool worker nodes.
+New, completely set up worker.
+ +Inherited from AbstractPool.createAndSetupWorker
+Protected
createInherited from AbstractPool.findFreeWorker
-Creates a new worker.
+Newly created worker.
+ +Overrides AbstractPool.createWorker
+Inherited from AbstractPool.getWorkerAverageTasksRunTime
-Terminate every current worker in this pool.
+Inherited from AbstractPool.destroy
+Protected
destroyTerminates the given worker.
+Inherited from AbstractPool.getWorkerIndex
-Overrides AbstractPool.destroyWorker
+Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.getWorkerRunningTasks
-Initializes tasks usage statistics.
+Whether to enable or disable the worker tasks queue.
The worker.
-Inherited from AbstractPool.initWorkerTasksUsage
-Protected
internalOptional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+Executes 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.
+Inherited from AbstractPool.internalExecute
-Protected
internalPromise that will be fulfilled when the task is completed.
+ +Inherited from AbstractPool.execute
+Protected
internalInherited from AbstractPool.internalGetBusyStatus
-Protected
isWhether worker nodes are executing at least one task.
+Worker nodes busyness boolean status.
+ +Inherited from AbstractPool.internalBusy
+Protected
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.
+Sends a message to the given worker.
The worker that will be removed.
-Inherited from AbstractPool.removeWorker
-Protected
sendThe worker which should receive the message.
+The message.
+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
setupOverrides AbstractPool.setupHook
-Protected
workerSetup 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.
- -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.
+This function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+This function 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 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.
- -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
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0