X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=9ae89b09e3aae3a0d35cdf97aa90287ffb6cda0f;hb=05132b129c331aeec41f5878d58456675e00dbd4;hp=9e33831153c969707ae03e8558f32410d4b992b6;hpb=15e4d8f3cafe9f7412913b0e440921e813bdf3cd;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 9e338311..9ae89b09 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -
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.
+Type of execution response. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable 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.
-Optional
Readonly
emitterEmitter on which events can be listened to.
+Optional
emitterEvent emitter integrated with async resource on which events can be listened to.
+The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
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).Readonly
fileProtected
Readonly
filePath to the worker file.
-Readonly
numberProtected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
Readonly
numberNumber of workers that this pool should manage.
-Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from AbstractPool.opts
Protected
promiseThe execution response promise map.
+Protected
promiseThe 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.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
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workerReadonly
Internal
workerPool worker nodes.
-Inherited from AbstractPool.workerNodes
Protected
busyProtected
busyWhether the pool is busy or not.
The pool busyness boolean status.
Overrides AbstractPool.busy
Protected
fullProtected
fullWhether the pool is full or not.
The pool filling boolean status.
Overrides AbstractPool.full
+Inherited from AbstractPool.full
Private
numberPool information.
+Inherited from AbstractPool.info
+Protected
maxThe pool maximum size.
+Inherited from AbstractPool.maxSize
+Protected
minNumber of tasks queued in the pool.
+The pool minimum size.
Inherited from AbstractPool.numberOfQueuedTasks
+Inherited from AbstractPool.minSize
Private
numberPrivate
readyNumber of tasks running in the pool.
+The pool readiness boolean status.
Inherited from AbstractPool.numberOfRunningTasks
+Inherited from AbstractPool.ready
Protected
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Overrides AbstractPool.type
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Inherited from AbstractPool.utilization
+Protected
workerThe worker type.
+Overrides AbstractPool.worker
+Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true
if the task function was added, false
otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Inherited from AbstractPool.addTaskFunction
+Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -272,40 +402,45 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
Protected
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.
-Overrides AbstractPool.afterWorkerSetup
+The newly created worker node key.
+Inherited from AbstractPool.afterWorkerNodeSetup
Protected
beforeProtected
beforeThe task to execute.
+Inherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseProtected
createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+Creates a new, completely set up dynamic worker node.
Inherited from AbstractPool.chooseWorkerNode
+New, completely set up dynamic worker node key.
+ +Inherited from AbstractPool.createAndSetupDynamicWorkerNode
Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
+Creates a new, completely set up worker node.
Inherited from AbstractPool.createAndSetupWorker
+New, completely set up worker node key.
+ +Inherited from AbstractPool.createAndSetupWorkerNode
Protected
createProtected
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Overrides AbstractPool.createWorker
Protected
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Overrides AbstractPool.deregisterWorkerMessageListener
+Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Inherited from AbstractPool.destroy
Protected
destroyProtected
destroyShutdowns the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+The worker node key.
+Overrides AbstractPool.destroyWorkerNode
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.
+Inherited from AbstractPool.enableTasksQueue
Executes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+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.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+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.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from AbstractPool.execute
Protected
flagInherited from AbstractPool.flagWorkerNodeAsNotReady
+Protected
flushInherited from AbstractPool.flushTasksQueue
+Protected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Inherited from AbstractPool.getWorkerInfo
+Whether the specified task function exists in this pool.
+The name of the task function.
+true
if the task function exists, false
otherwise.
Inherited from AbstractPool.hasTaskFunction
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+The worker node key.
+true
if the worker node has back pressure, false
otherwise.
Inherited from AbstractPool.hasWorkerNodeBackPressure
+Protected
internalProtected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from AbstractPool.internalBusy
Protected
isProtected
isShould return whether the worker is the main worker or not.
Overrides AbstractPool.isMain
Lists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from AbstractPool.listTaskFunctionNames
+Protected
registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Overrides AbstractPool.registerOnceWorkerMessageListener
+Protected
registerProtected
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.
Overrides AbstractPool.registerWorkerMessageListener
Removes a task function from this pool.
+The name of the task function.
+true
if the task function was removed, false
otherwise.
Inherited from AbstractPool.removeTaskFunction
+Protected
sendInherited from AbstractPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Overrides AbstractPool.sendStartupMessageToWorker
+Protected
sendProtected
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.
-Overrides AbstractPool.sendToWorker
Sets the default task function in this pool.
+The name of the task function.
+true
if the default task function was set, false
otherwise.
Inherited from AbstractPool.setDefaultTaskFunction
+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.
+Inherited from AbstractPool.setTasksQueueOptions
Sets the worker choice strategy in this pool.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Inherited from AbstractPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
-Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupProtected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes 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.
+Starts the minimum number of workers in this pool.
Inherited from AbstractPool.start
+Protected
workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
+This method is the message listener registered on each worker.
Inherited from AbstractPool.workerListener
+Inherited from AbstractPool.workerMessageListener
Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
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.
- -Author
Christopher Quadflieg
+Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0