X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=9283ff10c255dab55704f19a246c87e8453cabac;hb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;hp=bf67558965e87ec5bc4d2f7b7682f78b2cde7b5f;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index bf675589..9283ff10 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -29,12 +29,12 @@
Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly
workerProtected
fullProtected
Abstract
maxProtected
Abstract
minProtected
Abstract
typeProtected
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
beforeHook executed before the worker task execution. Can be overridden.
@@ -380,11 +385,16 @@ Can be overridden.The worker node key.
The task to execute.
+Private
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.
+Terminate 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
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: numberProtected
internalProtected
Abstract
isPrivate
pushProtected
Abstract
registerPrivate
registerRegisters a listener callback on the given worker.
@@ -759,12 +799,12 @@ Can be overridden.Private
removeProtected
Abstract
sendThe message.
Implementation of IPool.setTasksQueueOptions
The worker choice strategy.
Implementation of IPool.setWorkerChoiceStrategy
Implementation of IPool.setWorkerChoiceStrategyOptions
Private
setPrivate
setSets the given worker in the pool worker nodes.
+Sets the given worker node its tasks usage in the pool.
The worker node key.
-The worker.
-The worker tasks usage.
+The worker node.
Private
setPrivate
setSets the given worker node its tasks usage in the pool.
-The worker node.
-The worker node tasks usage.
-Protected
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
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.
@@ -92,7 +92,8 @@ check Valid Tasks Queue Options
check Valid Worker Choice Strategy
check Valid Worker Choice Strategy Options
-choose Worker Node
+choose Worker Node
+create And Setup Dynamic Worker
create And Setup Worker
create Worker
dequeue Task
@@ -105,21 +106,26 @@
flush Tasks Queue
flush Tasks Queues
get Worker Node Key
+get Worker Usage
internal Busy
is Main
push Worker Node
-register Worker Message Listener
+register Worker Message Listener
remove Worker Node
send To Worker
set Tasks Queue Options
set Worker Choice Strategy
set Worker Choice Strategy Options
-set Worker Node
set Worker Node Tasks Usage
+set Worker Statistics
setup Hook
+shall Create Dynamic Worker
+tasks Max Queue Size
tasks Queue Size
-update Run Time Tasks Usage
-update Wait Time Tasks Usage
+update Elu Worker Usage
+update Run Time Worker Usage
+update Task Statistics Worker Usage
+update Wait Time Worker Usage
worker Listener