X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hb=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;hp=51fda18c1a4652e54b40f9dfbc94118aebd80073;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 51fda18c..c6bf43ba 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.
@@ -382,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.
@@ -761,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
setSets the given worker in the pool worker nodes.
-The worker node key.
-The worker.
-The worker tasks usage.
-The worker task queue.
-Private
setSets the given worker node its tasks usage in the pool.
Private
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
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,23 +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 Elu Tasks Usage
-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