X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=a82edebe09444cd3162070324281c76882dfe812;hb=5e972953bf3193a557a14fa794d559b2acc1d6de;hp=414fd92acf39b338d3e544da1e288312af260dbe;hpb=67e8ef11907ab8ae70740d7c9f4d5d225ed8d522;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 414fd92a..a82edebe 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
Protected
Optional
aliveProtected
Readonly
isProtected
lastProtected
Readonly
mainProtected
Readonly
optsProtected
statisticsProtected
taskAdds 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.
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.
Private
beginOptional
name: stringPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
endProtected
getPrivate
getGets the task function in the given scope.
+Gets the task function with the given name.
Optional
name: stringName of the function that will be returned.
+Name of the task function that will be returned.
Protected
handleChecks 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.
Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Protected
messageMessage received.
+The received message.
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.
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.
Protected
runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Protected
runRuns the given function asynchronously.
+Runs the given task function asynchronously.
Function that will be executed.
+Task function that will be executed.
Inherited from AsyncResource.runInAsyncScope
Protected
runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
+Task function that will be executed.
Protected
sendSends the ready response to the main worker.
+Protected
Abstract
sendPrivate
startSets 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.
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.
Private
startStarts the worker alive check interval.
+Starts the worker check active interval.
Private
stopPrivate
stopStops the worker alive check interval.
+Stops the worker check active interval.
Inherited from AsyncResource.triggerAsyncId
Protected
workerPrivate
updateNotifies the main worker that this worker is ready to process tasks.
-Static
bindInherited from AsyncResource.bind
Handler id of the
+aliveInterval
worker alive check. Interval
+Protected
Optional
activeHandler id of the
activeInterval
worker activity check.Protected
Abstract
id