X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractWorker.html;h=83823ef34f77b0afa3518d50743409132d3fdc02;hb=b5f1d0268446c60c01e1adac42e4c6cc2ec0f38f;hp=4f0e8c0b1bdb1a8cb2a8a46a3c2f59d601eccac2;hpb=069e56f4a71b48e89eeb1b4b2ccf693b75116f07;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 4f0e8c0b..83823ef3 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -
Protected
Abstract
idProtected
Readonly
isProtected
lastPrivate
Readonly
mainProtected
optsProtected
statisticsProtected
taskWhether the task function was added or not.
+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.
Inherited from AsyncResource.asyncId
Private
beginOptional
name: stringInherited from AsyncResource.bind
Private
checkPrivate
checkhttps://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
Private
checkPrivate
checkPrivate
checkChecks if the taskFunctions
parameter is passed to the constructor.
Checks if the taskFunctions
parameter is passed to the constructor and valid.
Private
checkInherited from AsyncResource.emitDestroy
Private
endProtected
getReference to the main worker.
-Private
getGets the task function with the given name.
-Optional
name: stringName of the task function that will be returned.
-The task function.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
+https://nodejs.org/api/errors.html#class-error If the main worker is not set.
Protected
handleHandles an error and convert it to a string so it can be sent back to the main worker.
The error raised by the worker.
Protected
handleHandles a kill message sent by the main worker.
The kill message.
-Protected
Abstract
handleProtected
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.
+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.
Lists the names of the worker's task functions.
Protected
messageRemoves a task function from the worker.
The name of the task function to remove.
Whether the task function existed and was removed or not.
+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.
Protected
runhttps://nodejs.org/api/errors.html#class-error If the task function is not found.
-Protected
runInherited from AsyncResource.runInAsyncScope
Protected
runProtected
sendProtected
sendSends the list of task function names to the main worker.
+Sends task function names to the main worker.
Protected
Abstract
sendSets 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.
Whether the default task function was set or not.
-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
startPrivate
stopInherited from AsyncResource.triggerAsyncId
Private
updateStatic
bindInherited from AsyncResource.bind
Generated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
Adds a task function to the worker. If a task function with the same name already exists, it is replaced.
@@ -244,17 +243,11 @@ If a task function with the same name already exists, it is replaced.The task function to add.