X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=b2f7708126032076cac10faa516f6af64c3c4b2b;hb=6cc77e23e4838a1419951a51e12f0dc39dce0319;hp=01b345413a9ba482ecc0cbdf277f3b01a59ce803;hpb=f05afd162e34836a52c48b05781750e3421424d8;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 01b34541..b2f77081 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -29,12 +29,12 @@
Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promisePrivate
Readonly
startThe start timestamp of the pool.
+Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly
workerProtected
fullProtected
Abstract
maxProtected
Abstract
minPrivate
runGets the pool run time.
+The pool run time in milliseconds.
+ +Protected
Abstract
typePrivate
utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected
Abstract
workerThe received message.
Protected
Abstract
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.
Protected
beforePrivate
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkProtected
choosePrivate
chooseProtected
createProtected
createProtected
Abstract
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Private
dequeueShutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Protected
Abstract
destroyShutdowns the given worker.
+Terminates the given worker.
Private
enqueueOptional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified worker function. This can only be structured-cloneable data.
Private
executePrivate
flushPrivate
flushPrivate
getPrivate
getGet the worker given its id.
+The worker if found in the pool worker nodes, undefined
otherwise.
Private
getPrivate
getThe worker.
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
The worker node key if found in the pool worker nodes, -1
otherwise.
Private
getOptional
workerNodeKey: numberPrivate
handlePrivate
handleProtected
internalProtected
Abstract
isPrivate
pushProtected
Abstract
registerPrivate
registerRegisters a listener callback on the given worker.
@@ -793,12 +904,12 @@ Can be overridden.Private
removeProtected
Abstract
sendThe message.
Implementation of IPool.setTasksQueueOptions
Implementation of IPool.setWorkerChoiceStrategy
Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setPrivate
setProtected
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.
Private
shallConditions for dynamic worker creation.
+Whether to create a dynamic worker or not.
+ +Private
tasksPrivate
tasksPrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerThe listener function to execute when a message is received from a worker.
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -66,6 +66,7 @@ number Of Workers
opts
promise Response Map
+start Timestamp
worker Choice Strategy Context
worker Nodes