X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=bcf1047c5bb6d677bb5490f6171d2892b80a92b7;hb=b83746e48f09324273c37450e1adefbd4c13efe3;hp=d2afab17aafc0ad98c26178a0e85ce14c8461062;hpb=2493c34370d0839614058bb55254fd7aec91b664;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index d2afab17..bcf1047c 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,8 +1,8 @@ -
Abstract
Protected
createProtected
createCreates a new, completely set up worker node.
+Protected
createPrivate
createCreates a worker node.
+Private
createCreates a worker node.
The created worker node.
-Private
dequeueProtected
Abstract
deregisterDeregisters a listener callback on the worker given its worker node key.
+Private
dequeueProtected
Abstract
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
destroyOptional
tasksQueueOptions: TasksQueueOptionsPrivate
enqueuePrivate
executeOptional
tasksQueueOptions: TasksQueueOptionsPrivate
enqueuePrivate
executeProtected
flagProtected
flushPrivate
flushPrivate
Readonly
getProtected
flagProtected
flushPrivate
flushPrivate
Readonly
getGets task function worker choice strategy, if any.
Optional
name: stringThe task function name.
The task function worker choice strategy if the task function worker choice strategy is defined, undefined
otherwise.
Private
Readonly
getGets the worker choice strategies registered in this pool.
+Private
getPrivate
Readonly
getGets the worker choice strategies registered in this pool.
The worker choice strategies.
-Protected
getGets the worker information given its worker node key.
+Protected
getGets the worker information given its worker node key.
The worker node key.
The worker information.
-Private
getGets the worker node key given its worker id.
+Private
getPrivate
Readonly
getGets worker node task function priority, if any.
+Private
Readonly
getGets worker node task function priority, if any.
The worker node key.
Optional
name: stringThe task function name.
The worker node task function priority if the worker node task function priority is defined, undefined
otherwise.
Private
Readonly
getGets worker node task function worker choice strategy, if any.
+Private
Readonly
getGets worker node task function worker choice strategy, if any.
The worker node key.
Optional
name: stringThe task function name.
The worker node task function worker choice strategy if the worker node task function worker choice strategy is defined, undefined
otherwise.
Private
handlePrivate
handlePrivate
Readonly
handlePrivate
Readonly
handleOptional
previousStolenTask: Task<Data>Private
handlePrivate
hasPrivate
initPrivate
initInitializes the worker node usage with sensible default values gathered during runtime.
+Private
handlePrivate
handlePrivate
Readonly
handlePrivate
Readonly
handleOptional
previousStolenTask: Task<Data>Private
handlePrivate
hasPrivate
initPrivate
initInitializes the worker node usage with sensible default values gathered during runtime.
The worker node.
-Protected
internalProtected
internalProtected
Abstract
isReturns whether the worker is the main worker or not.
+Protected
Abstract
isPrivate
isPrivate
redistributeProtected
Abstract
registerRegisters once a listener callback on the worker given its worker node key.
+Private
isPrivate
redistributeProtected
Abstract
registerRegisters once a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
-Protected
Abstract
registerRegisters a listener callback on the worker given its worker node key.
+Protected
Abstract
registerRegisters a listener callback on the worker given its worker node key.
The worker node key.
The message listener callback.
-Private
removeRemoves the worker node from the pool worker nodes.
+Private
removeRemoves the worker node from the pool worker nodes.
The worker node.
-Private
resetPrivate
sendProtected
Abstract
sendPrivate
resetPrivate
sendProtected
Abstract
sendPrivate
sendPrivate
sendPrivate
sendPrivate
sendProtected
Abstract
sendPrivate
sendPrivate
sendProtected
Abstract
sendSends a message to worker given its worker node key.
The worker node key.
The message.
Optional
transferList: readonly TransferListItem[]The optional array of transferable objects.
-Private
setPrivate
setPrivate
setOptional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsProtected
setupPrivate
setPrivate
setPrivate
setPrivate
setOptional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsProtected
setupProtected
Abstract
shallProtected
Abstract
shallPrivate
shallPrivate
shallWhether the worker node shall update its task function worker usage or not.
+Private
shallPrivate
shallPrivate
startPrivate
tasksPrivate
unsetPrivate
unsetPrivate
updatePrivate
updateProtected
Readonly
workerThis method is the message listener registered on each worker.
-Private
Readonly
workerPrivate
startPrivate
tasksPrivate
unsetPrivate
unsetPrivate
updatePrivate
updateProtected
Readonly
workerThis method is the message listener registered on each worker.
+Private
Readonly
worker
Base class that implements some shared logic for all poolifier pools.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.13Class AbstractPool<Worker, Data, Response>
Abstract
Base class that implements some shared logic for all poolifier pools.
Type Parameters
Type of worker which manages this pool.
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)
Implements
Index
Constructors
Hierarchy (view full)
Implements
Index
Constructors
Properties
Path to the worker file.
Options for the pool.
Optional
maximumNumberOfWorkers: numberMaximum number of workers that this pool manages.
-Returns AbstractPool<Worker, Data, Response>
Properties
Private
destroyingWhether the pool is destroying or not.
-Optional
emitterPool event emitter integrated with async resource. +
Returns AbstractPool<Worker, Data, Response>
Properties
Private
destroyingWhether the pool is destroying or not.
+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:
@@ -128,124 +130,124 @@ 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.
-Private
readyWhether the pool ready event has been emitted or not.
-Private
Optional
startThe start timestamp of the pool.
-Private
startedWhether the pool is started or not.
-Private
startingWhether the pool is starting or not.
-Private
startingWhether the minimum number of workers is starting or not.
-Private
Readonly
taskThe task functions added at runtime map:
+Private
readyWhether the pool ready event has been emitted or not.
+Private
Optional
startThe start timestamp of the pool.
+Private
startedWhether the pool is started or not.
+Private
startingWhether the pool is starting or not.
+Private
startingWhether the minimum number of workers is starting or not.
+Private
Readonly
taskThe task functions added at runtime map:
key
: The task function name.value
: The task function object.Protected
Optional
workerWorker choice strategies context referencing worker choice algorithms implementation.
-Readonly
Internal
workerPool worker nodes.
-Accessors
Protected
Abstract
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
Abstract
busyWhether the pool is busy or not.
The pool busyness boolean status.
-Returns boolean
Protected
emptyThe pool emptiness 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
Private
readyThe pool readiness boolean status.
-Returns boolean
Protected
Abstract
typeThe pool type.
+Returns boolean
info
Pool information.
+Returns PoolInfo
Private
readyThe pool readiness boolean status.
+Returns boolean
Protected
Abstract
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
Abstract
workerThe worker type.
-Returns "thread" | "cluster"
Methods
add Task Function
Parameters
Returns Promise<boolean>
Inherit Doc
Private
addAdds the given worker node in the pool worker nodes.
+Protected
Abstract
workerThe worker type.
+Returns "thread" | "cluster"
Methods
add Task Function
Parameters
Returns Promise<boolean>
Inherit Doc
Private
addAdds the given worker node in the pool worker nodes.
Parameters
The worker node.
Returns number
The added worker node key.
Throws
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
-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
Private
buildParameters
Returns TasksQueueOptions
Private
cannotReturns boolean
Protected
Abstract
checkEmits dynamic worker creation events.
-Returns void
Private
checkReturns void
Private
checkReturns void
Private
checkReturns void
Private
checkReturns void
Private
checkChecks if the worker id sent in the received message from a worker is valid.
+Returns void
Private
buildParameters
Returns TasksQueueOptions
Private
cannotReturns boolean
Protected
Abstract
checkEmits dynamic worker creation events.
+Returns void
Private
checkReturns void
Private
checkReturns void
Private
checkReturns void
Private
checkReturns void
Private
checkChecks if the worker id sent in the received message from a worker is valid.
Parameters
The received message.
Returns void
Throws
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
-Private
checkParameters
Returns void
Private
checkParameters
Returns void
Private
checkReturns void
Private
checkParameters
Returns void
Private
chooseChooses a worker node for the next task.
+Private
checkParameters
Returns void
Private
checkParameters
Returns void
Private
checkReturns void
Private
checkParameters
Returns void
Private
chooseChooses a worker node for the next task.
Parameters
Optional
name: stringThe task function name.
-Returns number
The chosen worker node key
-Protected
createCreates a new, completely set up dynamic worker node.
+Returns number
The chosen worker node key.
+