X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedThreadPool.html;h=a5610b1077aaed4069aa78e428b9441381c65e1e;hb=184d530faf6acf70e116cb4a3fb831938b73e2c0;hp=b8b8e4a84c8891535718d2298c9bdce134c0b3d3;hpb=881050e41e8c464ce0c3537d05898bd42ed87631;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b8b8e4a8..c7d211d6 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.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 thread pool.
Number of threads for this pool.
Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Options for this fixed thread pool.
Overrides AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>.constructor
+Overrides AbstractPool.constructor
Optional
Readonly
emitterInherited from AbstractPool.emitter
-Readonly
fileInherited from AbstractPool.filePath
-Protected
nextId of the next message.
+ +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.'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
+Protected
Readonly
optsOptions for the pool.
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.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 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
workersInherited from AbstractPool.workers
-Readonly
workersInherited from AbstractPool.workersTasksUsage
-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
fullWhether 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.
+Inherited from AbstractPool.numberOfRunningTasks
+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.
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.
- -Worker.
+Chooses a worker node for the next task.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Inherited from AbstractPool.chooseWorker
+The worker node key
+Inherited from AbstractPool.chooseWorkerNode
Protected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Creates a new worker and sets it up completely in the pool worker nodes.
Inherited from AbstractPool.createAndSetupWorker
+New, completely set up worker.
+Inherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
+Returns a newly created worker.
+Overrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
-Overrides AbstractPool.destroyWorker
-Shutdowns every current worker in this pool.
+Inherited from AbstractPool.destroy
+Protected
destroyShutdowns the given worker.
+Inherited from AbstractPool.execute
-Inherited from AbstractPool.findFreeWorker
-A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.getWorkerAverageTasksRunTime
-Whether to enable or disable the worker tasks queue.
+Inherited from AbstractPool.getWorkerIndex
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
Inherited from AbstractPool.getWorkerRunningTasks
-Protected
internalExecutes 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
+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.
+Sends a message to the given worker.
The 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
+Inherited from AbstractPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+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.
- -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
Type of data sent to the worker. This can only be serializable data.