X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=0ba79d7ac18e75fc1c681e2bc67fe6f4684d0af7;hb=a1e5b51ea192bdcad4751d1f4facc19498ee4f1d;hp=8ea3cf710b5237793d0e3cf4133d5eb57578ab14;hpb=ed1ecf09c599769ed61771ec25d71c39c19ba70b;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 8ea3cf71..0ba79d7a 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,15 @@ -
Constructs a new poolifier fixed thread pool.
Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Optional
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}Options for this fixed thread pool.
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
fileInherited from AbstractPool.filePath
-Optional
Readonly
maxInherited from AbstractPool.max
-Protected
nextId of the next message.
+Path to the worker file.
Inherited from AbstractPool.nextMessageId
+Inherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
+Number of workers that this pool should manage.
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
+ +Options for the pool.
+Inherited from AbstractPool.opts
Protected
promiseThe promise map.
+Protected
promiseThe execution response 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.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 and resolve/reject the promise based on 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.promiseMap
+Inherited from AbstractPool.promiseResponseMap
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
+Inherited from AbstractPool.workerChoiceStrategyContext
+Readonly
workerPool worker nodes.
Inherited from AbstractPool.workerChoiceStrategyContext
-Readonly
workersInherited from AbstractPool.workers
-Readonly
workersInherited from AbstractPool.workersTasksUsage
-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.
+Inherited from AbstractPool.numberOfQueuedTasks
+Private
numberNumber of tasks running in the pool.
+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 received message.
+The worker.
Inherited from AbstractPool.afterPromiseWorkerResponseHook
+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.
+The worker node key.
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+Inherited from AbstractPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Worker.
+[worker node key, worker node].
Inherited from AbstractPool.chooseWorker
+Inherited from AbstractPool.chooseWorkerNode
Protected
createCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
Inherited from AbstractPool.createAndSetupWorker
+Inherited from AbstractPool.createAndSetupWorker
Protected
createReturns a newly created worker.
+Overrides AbstractPool.createWorker
+Overrides AbstractPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from AbstractPool.destroy
+Inherited from AbstractPool.destroy
Protected
destroyShutdowns the given worker.
+A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+Overrides AbstractPool.destroyWorker
Inherited from AbstractPool.execute
-Inherited from AbstractPool.findFreeWorker
-Inherited from AbstractPool.getWorkerAverageTasksRunTime
-Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.getWorkerIndex
-Whether to enable or disable the worker tasks queue.
+Inherited from AbstractPool.getWorkerRunningTasks
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
Initializes tasks usage statistics.
+Executes the function specified in the constructor with the task data input parameter.
+ +Promise that will be resolved when the task is successfully completed.
The worker.
+The task input data for the specified function. This can only be serializable data.
Inherited from AbstractPool.initWorkerTasksUsage
+Inherited from AbstractPool.execute
Protected
internalInherited from AbstractPool.internalExecute
+Finds 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.
Inherited from AbstractPool.findFreeWorkerNodeKey
Protected
internalProtected
internalInherited from AbstractPool.internalGetBusyStatus
+Inherited from AbstractPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Overrides AbstractPool.isMain
+Overrides AbstractPool.isMain
Protected
registerRegisters a listener callback on the given worker.
+The 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.
+Sends a message to the given worker.
Worker that will be removed.
+The worker which should receive the message.
+The message.
Inherited from AbstractPool.removeWorker
+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.
+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.setWorkerChoiceStrategy
+Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Inherited from AbstractPool.setupHook
+Inherited from AbstractPool.setupHook
Protected
workerThis function is the listener registered for each 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.
+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
+Inherited from AbstractPool.workerListener
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
+