X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=75f41dbfacfc286e76e82cd0faf227fc2fa63e22;hb=a6d9dccfaf39e185c896747260d668fcb683a8ed;hp=5dff496fcdbe079d7bc3f674f45786369c13b47a;hpb=e4b9c7f546318de7603566b141fd0e2d0118c794;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5dff496f..75f41dbf 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Inherited from AbstractPool.emitter
Readonly
filePath to the worker-file.
-Protected
Readonly
filePath to the worker file.
+Inherited from AbstractPool.filePath
Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for the pool.
-Protected
Readonly
optsOptions for this fixed thread pool.
+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
Protected
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workerReadonly
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.
Overrides AbstractPool.full
-Private
numberInherited 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.
@@ -270,40 +315,45 @@ Can be overridden.The worker.
-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.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
The newly created worker.
-Overrides AbstractPool.afterWorkerSetup
-Protected
beforeInherited from AbstractPool.afterWorkerSetup
+Protected
beforeHook executed before the worker task execution. Can be overridden.
@@ -312,258 +362,303 @@ Can be overridden.The worker node key.
-The 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 dynamic worker and sets it up completely in the pool worker nodes.
Inherited from AbstractPool.chooseWorkerNode
-Protected
createNew, completely set up dynamic worker.
+ +Inherited from AbstractPool.createAndSetupDynamicWorker
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+ +Inherited from AbstractPool.createAndSetupWorker
Protected
createProtected
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Overrides AbstractPool.createWorker
Shutdowns every current worker in this pool.
+Terminate every current worker in this pool.
Inherited from AbstractPool.destroy
Protected
destroyShutdowns the given worker.
+Terminates the given worker.
A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
-Inherited from AbstractPool.execute
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from AbstractPool.enableTasksQueue
+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.
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 structured-cloneable data.
Inherited from AbstractPool.findFreeWorkerNodeKey
+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
internalProtected
internalWhether worker nodes are executing at least one task.
+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
Protected
sendRegisters a listener callback on the given worker.
+Sends a message to the given worker.
The worker which should register a listener.
-The worker which should receive the message.
+The message listener callback.
+The message.
Overrides AbstractPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Overrides AbstractPool.registerWorkerMessageListener
-Protected
sendThe worker tasks queue options.
+Inherited from AbstractPool.setTasksQueueOptions
+Sends a message to the given worker.
+Sets the worker choice strategy in this pool.
The worker which should receive the message.
-The worker choice strategy.
+The message.
-Overrides AbstractPool.sendToWorker
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from AbstractPool.setWorkerChoiceStrategy
Sets the worker choice strategy in this pool.
+Sets the worker choice strategy options in this pool.
The worker choice strategy.
-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
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Inherited from AbstractPool.setupHook
Protected
workerProtected
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.
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.
- -Author
Alessandro Pio Ardizio
+Author
Alessandro Pio Ardizio
-Since
0.0.1
+Since
0.0.1