X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=f81194d06075821dc8a17a645e0ee85bc7734870;hb=HEAD;hp=5407127f2f730d79132e2991321e6c195d5b32ca;hpb=224d008191f52fa20b93e1ba67919569f8d6e315;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 5407127f..64135314 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,11 @@ -
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
+- Preparing search index...
- The search index is not available
poolifier - v4.2.3Class DynamicThreadPool<Data, Response>
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
This thread pool creates new threads when the others are busy, up to the maximum number of threads. When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
emitter
.Author
Alessandro Pio Ardizio
Since
0.0.1
Type Parameters
Type of data sent to the worker. This can only be structured-cloneable data.
Type of execution response. This can only be structured-cloneable data.
-Hierarchy (view full)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Maximum number of threads that can be created by this pool.
Path to an implementation of a
ThreadWorker
file, which can be relative or absolute.Options for this dynamic thread pool.
-Returns DynamicThreadPool<Data, Response>
Properties
Optional
emitterPool event emitter integrated with async resource. +
Returns DynamicThreadPool<Data, Response>
Properties
Optional
emitterPool event emitter integrated with async resource. The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
@@ -71,92 +71,92 @@ The async tracking tooling identifier is
-poolifier:<PoolType>-<Wo
'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
filePath to the worker file.
-Protected
Optional
Readonly
maximumMaximum number of workers that this pool manages.
-Protected
Readonly
minimumMinimum number of workers that this pool manages.
-Protected
Readonly
optsOptions for the pool.
-Protected
promiseThe task execution response promise map:
+Protected
Readonly
filePath to the worker file.
+Protected
Optional
Readonly
maximumMaximum number of workers that this pool manages.
+Protected
Readonly
minimumMinimum number of workers that this pool manages.
+Protected
Readonly
optsOptions for the pool.
+Protected
promiseThe task execution response promise map:
key
: The message id of each submitted task.value
: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
-Protected
Optional
workerWorker choice strategies context referencing worker choice algorithms implementation.
-Readonly
Internal
workerPool worker nodes.
-Accessors
Protected
busyWhether the pool is busy or not.
+Protected
Optional
workerWorker choice strategies context referencing worker choice algorithms implementation.
+Readonly
Internal
workerPool worker nodes.
+Accessors
Protected
busyWhether the pool is busy or not.
Returns boolean
The pool busyness boolean status.
-Protected
emptyWhether the pool is empty or not.
+Protected
emptyWhether the pool is empty or not.
Returns boolean
The pool emptiness boolean status.
-Protected
fullWhether the pool is full or not.
+Protected
fullWhether the pool is full or not.
Returns boolean
The pool fullness boolean status.
-info
Pool information.
-Returns PoolInfo
Protected
typeThe pool type.
+info
Pool information.
+Returns PoolInfo
Protected
typeThe pool type.
If it is
-'dynamic'
, it provides themax
property.Returns "fixed" | "dynamic"
Protected
workerThe worker type.
-Returns "thread" | "cluster"
Methods
add Task Function
Parameters
The name of the task function.
+Returns "fixed" | "dynamic"
Protected
workerThe worker type.
+Returns "thread" | "cluster"
Methods
add Task Function
Parameters
The name of the task function.
The task function.
Returns Promise<boolean>
-true
if the task function was added,false
otherwise.Protected
afterHook executed after the worker task execution. +
Protected
afterHook executed after the worker task execution. Can be overridden.
Parameters
The worker node key.
The received message.
-Returns void
Protected
afterMethod hooked up after a worker node has been newly created. +
Returns void
Protected
afterMethod hooked up after a worker node has been newly created. Can be overridden.
Parameters
The newly created worker node key.
-Returns void
Protected
beforeHook executed before the worker task execution. +
Returns void
Protected
beforeHook executed before the worker task execution. Can be overridden.
Parameters
The worker node key.
The task to execute.
-Returns void
Protected
checkEmits dynamic worker creation events.
-Returns void
Protected
createCreates a new, completely set up dynamic worker node.
+Returns void
Protected
checkEmits dynamic worker creation events.
+Returns void
Protected
createCreates a new, completely set up dynamic worker node.
Returns number
New, completely set up dynamic worker node key.
-Protected
createCreates a new, completely set up worker node.
+Protected
createCreates a new, completely set up worker node.
Returns number
New, completely set up worker node key.
-Protected
deregisterDeregisters a listener callback on the worker given its worker node key.
+Protected
deregisterDeregisters a listener callback on the worker given its worker node key.
Type Parameters
Parameters
The worker node key.
The message listener callback.
-Parameters
Returns void
Returns void
destroy
Returns Promise<void>
Inherit Doc
Protected
destroyTerminates the worker node given its worker node key.
+Parameters
Returns void
Returns void
destroy
Returns Promise<void>
Inherit Doc
Protected
destroyTerminates the worker node given its worker node key.
Parameters
The worker node key.
-Returns Promise<void>
enable Tasks Queue
Parameters
Optional
tasksQueueOptions: TasksQueueOptionsReturns void
Inherit Doc
execute
Parameters
Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Returns Promise<void>
enable Tasks Queue
Parameters
Optional
tasksQueueOptions: TasksQueueOptionsReturns void
Inherit Doc
execute
Parameters
Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
Optional
transferList: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise with a task function response that will be fulfilled when the task is completed.
-Protected
flagParameters
Returns void
Protected
flushParameters
Returns number
Protected
getGets the worker information given its worker node key.
+Protected
flagParameters
Returns void
Protected
flushParameters
Returns number
Protected
getGets the worker information given its worker node key.
Parameters
The worker node key.
Returns undefined | WorkerInfo
The worker information.
-has Task Function
Parameters
The name of the task function.
+has Task Function
Parameters
The name of the task function.
Returns boolean
-true
if the task function exists,false
otherwise.Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
Returns boolean
Worker nodes busyness boolean status.
-Protected
isReturns whether the worker is the main worker or not.
+Protected
isReturns whether the worker is the main worker or not.
Returns boolean
-true
if the worker is the main worker,false
otherwise.list Task Functions Properties
Returns TaskFunctionProperties[]
The properties of task functions available in this pool.
-map Execute
Parameters
The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.
+list Task Functions Properties
Returns TaskFunctionProperties[]
The properties of task functions available in this pool.
+map Execute
Parameters
The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.
Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
Optional
transferList: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response[]>
Promise with an array of task function responses that will be fulfilled when the tasks are completed.
-Protected
registerRegisters once a listener callback on the worker given its worker node key.
+Protected
registerRegisters once a listener callback on the worker given its worker node key.
Type Parameters
Parameters
The worker node key.
The message listener callback.
-Parameters
Returns void
Returns void
Protected
registerRegisters a listener callback on the worker given its worker node key.
+Parameters
Returns void
Returns void
Protected
registerRegisters a listener callback on the worker given its worker node key.
Type Parameters
Parameters
The worker node key.
The message listener callback.
-Parameters
Returns void
Returns void
remove Task Function
Parameters
The name of the task function.
+Parameters
Returns void
Returns void
remove Task Function
Parameters
The name of the task function.
Returns Promise<boolean>
-true
if the task function was removed,false
otherwise.Protected
sendSends the startup message to worker given its worker node key.
+Protected
sendSends the startup message to worker given its worker node key.
Parameters
The worker node key.
-Returns void
Protected
sendSends a message to worker given its worker node key.
+Returns void
Protected
sendSends a message to worker given its worker node key.
Parameters
The worker node key.
The message.
Optional
transferList: readonly TransferListItem[]The optional array of transferable objects.
-Returns void
set Default Task Function
Parameters
The name of the task function.
+Returns void
set Default Task Function
Parameters
The name of the task function.
Returns Promise<boolean>
-true
if the default task function was set,false
otherwise.set Tasks Queue Options
Parameters
Returns void
Inherit Doc
set Worker Choice Strategy
Parameters
    | "ROUND_ROBIN"
    | "LEAST_USED"
    | "LEAST_BUSY"
    | "LEAST_ELU"
    | "FAIR_SHARE"
    | "WEIGHTED_ROUND_ROBIN"
    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsReturns void
Inherit Doc
set Worker Choice Strategy Options
Parameters
The worker choice strategy options.
+set Tasks Queue Options
Parameters
Returns void
Inherit Doc
set Worker Choice Strategy
Parameters
    | "ROUND_ROBIN"
    | "LEAST_USED"
    | "LEAST_BUSY"
    | "LEAST_ELU"
    | "FAIR_SHARE"
    | "WEIGHTED_ROUND_ROBIN"
    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsReturns void
Inherit Doc
set Worker Choice Strategy Options
Parameters
The worker choice strategy options.
Returns boolean
-true
if the worker choice strategy options were set,false
otherwise.Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +
Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. Can be overridden.
-Returns void
Protected
shallConditions for dynamic worker creation.
+Returns void
Protected
shallConditions for dynamic worker creation.
Returns boolean
Whether to create a dynamic worker or not.
-start
Returns void
Inherit Doc
Protected
Readonly
workerThis method is the message listener registered on each worker.
+start
Returns void
Inherit Doc
Protected
Readonly
workerThis method is the message listener registered on each worker.
Parameters
The message received from the worker.
-Returns void
Settings
On This Page
Constructors
Properties
Accessors
Methods
Returns void
Settings
On This Page
Constructors
Properties
Accessors
Methods