X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=40cc3626ea24bbdd9c5fa631a5c5256f6eb3f54f;hb=d3127e8409afde2d33be3bf0a04065da98b535c7;hp=7b890594753e7aef46f705fe2a7f97272eb35f96;hpb=0770fe626b2bb3212a1d73fa4764973ac92e241a;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 7b890594..40cc3626 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
emitter{@inheritDoc}
+ +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
+Inherited from AbstractPool.emitter
Readonly
filePath to the worker-file.
+Path to the worker file.
Inherited from AbstractPool.filePath
+Inherited from AbstractPool.filePath
Readonly
numberNumber of workers that this pool should manage.
Inherited from AbstractPool.numberOfWorkers
+Inherited from AbstractPool.numberOfWorkers
Readonly
optsOptions for the pool.
Inherited from AbstractPool.opts
+Inherited from AbstractPool.opts
Protected
promiseThe promise response map.
+The execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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.
+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
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
+Inherited from AbstractPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
+Readonly
workerPool worker nodes.
Inherited from AbstractPool.workers
+Inherited from AbstractPool.workerNodes
Protected
busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Overrides AbstractPool.busy
Protected
full{@inheritDoc}
+Whether 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 concurrently running.
+Number of tasks running in the pool.
Inherited from AbstractPool.numberOfRunningTasks
Pool maximum size.
+Overrides AbstractPool.size
+{@inheritDoc}
+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 worker.
The received message.
Inherited from AbstractPool.afterPromiseResponseHook
+Inherited from AbstractPool.afterTaskExecutionHook
Protected
after{@inheritDoc}
+Function 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 key.
+The worker node key.
Inherited from AbstractPool.beforePromiseResponseHook
+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 key, worker].
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
Inherited from AbstractPool.chooseWorker
+[worker node key, worker node].
+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
create{@inheritDoc}
+Returns a newly created worker.
Overrides AbstractPool.createWorker
+Overrides AbstractPool.createWorker
{@inheritDoc}
+Shutdowns every current worker in this pool.
Inherited from AbstractPool.destroy
-Inherited from AbstractPool.destroy
+Protected
destroy{@inheritDoc}
+Shutdowns the given worker.
Overrides AbstractPool.destroyWorker
-A worker within workerNodes
.
Overrides AbstractPool.destroyWorker
+{@inheritDoc}
+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
+{@inheritDoc}
+Executes the function specified in the worker constructor with the task data input parameter.
Inherited from AbstractPool.findFreeWorkerKey
+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
is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Overrides AbstractPool.isMain
+Overrides AbstractPool.isMain
Protected
register{@inheritDoc}
+Registers 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.
The worker that will be removed.
+The worker which should receive the message.
+The message.
Inherited from AbstractPool.removeWorker
+Overrides AbstractPool.sendToWorker
Protected
send{@inheritDoc}
+Sets the worker tasks queue options in this pool.
The worker tasks queue options.
+Overrides AbstractPool.sendToWorker
+Inherited from AbstractPool.setTasksQueueOptions
{@inheritDoc}
+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.