X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedThreadPool.html;h=ae58396eff50db7c1c66ca5a4fc3463f5a0fa502;hb=5d59ef8fc3bb4082501d2f84c14408a2b7fcfacd;hp=0d7ade42a1e8f87931fc4326d2beec85bc6f1d6a;hpb=71218fcd1ded9a614da1fc09794a0c213ce059c9;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 0d7ade42..ae58396e 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,22 +1,21 @@ -
Protected
beforeHook executed before the worker task execution. Can be overridden.
The worker node key.
-The task to execute.
-Protected
createProtected
checkProtected
createProtected
createCreates a new, completely set up worker node.
+Protected
createProtected
createProtected
deregisterDeregisters a listener callback on the worker given its worker node key.
-The worker node key.
+Protected
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
The message listener callback.
-Protected
destroyTerminates the worker node given its worker node key.
+Protected
destroyEnables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker node tasks queue.
Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Executes the specified function in the worker constructor with the task data input parameter.
+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: 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.
-Promise that will be fulfilled when the task is completed.
-Protected
flagProtected
flushProtected
getGets the worker information given its worker node key.
+Optional
transferList: 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.
+Promise that will be fulfilled when the task is completed.
+Protected
flagProtected
flushProtected
getGets the worker information given its worker node key.
The worker node key.
-The worker information.
-The worker information.
+Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Protected
internalProtected
isLists the names of task function available in this pool.
+Protected
isProtected
registerRegisters once a listener callback on the worker given its worker node key.
-The worker node key.
+Protected
registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
The message listener callback.
-Protected
registerRegisters a listener callback on the worker given its worker node key.
-The worker node key.
+Protected
registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
The message listener callback.
-Removes a task function from this pool.
+Protected
sendProtected
sendtrue
if the task function was removed, false
otherwise.
Protected
sendProtected
sendProtected
sendSends a message to worker given its worker node key.
The worker node key.
-The message.
-Optional
transferList: TransferListItem[]The optional array of transferable objects.
-Sets the default task function in this pool.
+The message.
+Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Sets the worker node tasks queue options in this pool.
-The worker node tasks queue options.
-Sets the worker choice strategy in this pool.
+true
if the default task function was set, false
otherwise.
Sets the worker node tasks queue options in this pool.
+The worker node tasks queue options.
+Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Sets the worker choice strategy options in this pool.
-The worker choice strategy options.
-Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Protected
setupProtected
workerThis method is the message listener registered on each worker.
-Generated using TypeDoc
Protected
shallProtected
Readonly
workerThis method is the message listener registered on each worker.
+Generated using TypeDoc
A thread pool with a fixed number of threads.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.19Class FixedThreadPool<Data, Response>
A thread pool with a fixed number of threads.
Author
Alessandro Pio Ardizio
Since
0.0.1
-Type Parameters
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
-Response = unknown
Type of execution response. This can only be structured-cloneable data.
-Hierarchy
Index
Constructors
Type Parameters
Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
+Response = unknown
Type of execution response. This can only be structured-cloneable data.
+Hierarchy (view full)
Index
Constructors
Properties
Accessors
Constructors
constructor
Constructs a new poolifier fixed thread pool.
-Type Parameters
Data = unknown
Response = unknown
Parameters
numberOfThreads: number
Number of threads for this pool.
+Constructors
constructor
Constructs a new poolifier fixed thread pool.
+Type Parameters
Data = unknown
Response = unknown
Parameters
numberOfThreads: number
Number of threads for this pool.
filePath: string
Path to an implementation of a
-ThreadWorker
file, which can be relative or absolute.opts: ThreadPoolOptions = {}
Options for this fixed thread pool.
-Returns FixedThreadPool<Data, Response>
Properties
Optional
emitterEvent emitter integrated with async resource on which events can be listened to. +
opts: ThreadPoolOptions = {}
Options for this fixed thread pool.
+Optional
maximumNumberOfThreads: numberReturns FixedThreadPool<Data, Response>
Properties
Optional
emitterEvent emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
-
+
+
-'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'empty'
: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'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
maxDynamic pool maximum size property placeholder.
-Protected
Readonly
numberNumber of workers that this pool should manage.
-Protected
Readonly
optsOptions for this fixed thread 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 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.
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Readonly
Internal
workerPool worker nodes.
-Accessors
Protected
busyWhether the pool is busy or not.
+Protected
Optional
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Readonly
Internal
workerPool worker nodes.
+Accessors
Protected
busyWhether the pool is busy or not.
The pool busyness boolean status.
-Returns boolean
Protected
fullWhether the pool is full or not.
+Returns boolean
Protected
emptyThe pool emptiness boolean status.
+Returns boolean
Protected
fullWhether the pool is full or not.
The pool filling boolean status.
-Returns boolean
info
Pool information.
-Returns PoolInfo
Protected
maxThe pool maximum size.
-Returns number
Protected
minThe pool minimum size.
-Returns number
Private
readyThe pool readiness boolean status.
-Returns boolean
Protected
typeThe pool type.
+Returns boolean
info
Pool information.
+Returns PoolInfo
Private
readyThe pool readiness boolean status.
+Returns boolean
Protected
typeThe pool type.
If it is
-'dynamic'
, it provides themax
property.Returns "fixed" | "dynamic"
Private
utilizationThe approximate pool utilization.
+Returns "fixed" | "dynamic"
Private
utilizationThe approximate pool utilization.
Returns number
The pool utilization.
-Protected
workerThe worker type.
-Returns "thread" | "cluster"
Methods
add Task Function
Adds a task function to this pool. +
Protected
workerThe worker type.
+Returns "thread" | "cluster"
Methods
add Task Function
Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.
Parameters
name: string
The name of the task function.
-fn: TaskFunction<Data, Response>
The task function.
-Returns Promise<boolean>
+true
if the task function was added,false
otherwise.fn: TaskFunction<Data, Response>
The task function.
+Returns Promise<boolean>
true
if the task function was added,false
otherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
name
parameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
-fn
parameter is not a function.Protected
afterHook executed after the worker task execution. +
Protected
afterHook executed after the worker task execution. Can be overridden.
Parameters
workerNodeKey: number
The worker node key.
-message: MessageValue<Response, unknown>
The received message.
-Returns void
Protected
afterMethod hooked up after a worker node has been newly created. +
message: MessageValue<Response, unknown>
The received message.
+Returns void
Protected
afterMethod hooked up after a worker node has been newly created. Can be overridden.
Parameters
workerNodeKey: number
The newly created worker node key.
-Returns void
Protected
beforeHook executed before the worker task execution. +
Returns void