X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=a1fecefd0d80aef3fcc6686da10fdc2d0c0537c6;hb=afa30fd0dd5bbc5d305cc30be663966a449efc08;hp=a7b5b27c4ec19ee612dde0598367a1310d42d962;hpb=18ba88e2f8612c6137bf564388ce8f905ae6d4ee;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a7b5b27c..a1fecefd 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
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 the pool.
-Inherited from AbstractPool.opts
+Inherited from AbstractPool.opts
Protected
promiseProtected
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
+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
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 execution. Can be overridden.
@@ -262,37 +319,45 @@ Can be overridden.The worker.
-The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
-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 execution. Can be overridden.
@@ -301,237 +366,335 @@ Can be overridden.The worker node key.
-Inherited from AbstractPool.beforeTaskExecutionHook
-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
createNew, completely set up worker.
+ +Inherited from AbstractPool.createAndSetupWorker
+Protected
createOverrides AbstractPool.createWorker
-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
-A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+Enables/disables the worker tasks queue in this pool.
+Inherited from AbstractPool.execute
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+Inherited from AbstractPool.findFreeWorkerNodeKey
-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.
+Optional
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
sendOverrides AbstractPool.registerWorkerMessageListener
+Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+Overrides AbstractPool.sendToWorker
-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.
+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
setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
Inherited from AbstractPool.setupHook
-Protected
workerInherited from 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 thread pool with a fixed number of threads.
It is possible to perform tasks in sync or asynchronous mode as you prefer.
This pool selects the threads in a round robin fashion.
+