X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FClusterWorker.html;h=198f20179cb872a754a0233e869e9f3922923962;hb=b4c2a50df77a5f3110d228436ce9f3008cbd8297;hp=8e355dd5cc732c4e3f3f551e4298b7984b3d947f;hpb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 8e355dd5..198f2017 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -
Options for the worker.
-Protected
Optional
Readonly
aliveHandler id of the aliveInterval
worker alive check.
Protected
Optional
activeHandler id of the activeInterval
worker activity check.
Protected
Readonly
isProtected
lastProtected
Readonly
mainReference to main worker.
-Protected
Readonly
optsProtected
optsOptions for the worker.
Protected
statisticsProtected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
Protected
idWorker id.
+Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+The name of the task function to add.
+The task function to add.
+Whether the task function was added or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
The function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
Protected
checkProtected
getReference to the main worker.
-Protected
handleHandles an error and convert it to a string so it can be sent back to the main worker.
@@ -276,14 +310,86 @@ never be called.The error raised by the worker.
+The error message.
+ +Inherited from AbstractWorker.handleError
+Protected
handleHandles a kill message sent by the main worker.
+The kill message.
+Inherited from AbstractWorker.handleKillMessage
+Protected
handleHandles the ready message sent by the main worker.
+The ready message.
+Overrides AbstractWorker.handleReadyMessage
+Checks if the worker has a task function with the given name.
+The name of the task function to check.
+Whether the worker has a task function with the given name or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
Inherited from AbstractWorker.hasTaskFunction
+Message of the error.
+The names of the worker's task functions.
Overrides AbstractWorker.handleError
+Inherited from AbstractWorker.listTaskFunctions
Protected
messageMessage received.
-The received message.
+Inherited from AbstractWorker.messageListener
Removes a task function from the worker.
+The name of the task function to remove.
+Whether the task function existed and was removed or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the task function used as default task function.
Inherited from AbstractWorker.removeTaskFunction
+Protected
runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Inherited from AbstractWorker.run
+Protected
runRuns the given function asynchronously.
+Runs the given task function asynchronously.
Function that will be executed.
-Task function that will be executed.
+Input data for the given function.
-Input data for the task function.
+Inherited from AbstractWorker.runAsync
The function to call in the execution context of this async resource.
Rest
...args: any[]Rest
...args: any[]Rest
Optional
thisArg: ThisThe receiver to be used for the function call.
-Optional
Rest
...args: any[]Optional arguments to pass to the function.
-Rest
v9.6.0
Inherited from AbstractWorker.runInAsyncScope
Protected
runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
-Task function that will be executed.
+Input data for the given function.
-Input data for the task function.
+Inherited from AbstractWorker.runSync
Protected
sendSends the list of task function names to the main worker.
+Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+Protected
sendSends a message to the main worker.
+Sends a message to main worker.
The response message.
-Overrides AbstractWorker.sendToMainWorker
Sets the default task function to use in the worker.
+The name of the task function to use as default task function.
+Whether the default task function was set or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name
parameter is a non-existing task function.
Inherited from AbstractWorker.setDefaultTaskFunction
+Inherited from AbstractWorker.triggerAsyncId
Static
bindThe function to bind to the current execution context.
-Optional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
Optional
thisArg: ThisArgOptional
thisArg: ThisArgOptional
v14.8.0, v12.19.0
Inherited from AbstractWorker.bind
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Task function(s) processed by the worker when the pool's
-execution
function is invoked.