X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractWorker.html;h=83823ef34f77b0afa3518d50743409132d3fdc02;hb=b5f1d0268446c60c01e1adac42e4c6cc2ec0f38f;hp=c2f2854f3ae42c55cd233b0c119469fea9f4c1a0;hpb=010ae1ba98e5ab018fa09870982d511c9389b48b;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c2f2854f..83823ef3 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -
Whether this is the main worker or not.
-Reference to main worker.
-Task function(s) processed by the worker when the pool's execution
function is invoked. The first function is the default function.
Options for the worker.
-Protected
Abstract
idProtected
Readonly
isProtected
lastPrivate
Readonly
mainProtected
optsProtected
statisticsProtected
taskAdds a task function to the worker. If a task function with the same name already exists, it is replaced.
@@ -232,22 +236,18 @@ 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.
Whether the task function was added or not.
-https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Inherited from AsyncResource.asyncId
Private
beginOptional
name: stringOptional
Optional
name: stringThe function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
Inherited from AsyncResource.bind
Private
checkPrivate
checkThe message to check.
-https://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.
The task function(s) parameter that should be checked.
-Private
checkPrivate
checkInherited from AsyncResource.emitDestroy
Private
endProtected
gethttps://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.
-The error message.
Protected
handleHandles a kill message sent by the main worker.
The kill message.
-Protected
Abstract
handleThe ready message.
-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.
+ + +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
messageThe 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 or an empty string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
Whether the task function existed and was removed or not.
-https://nodejs.org/api/errors.html#class-error If the name
parameter is the task function used as default task function.
Protected
runThe task to execute.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
-Protected
runTask function that will be executed.
-Input data for the task function.
-The function to call in the execution context of this async resource.
Rest
...args: any[]Rest
Rest
...args: any[]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 AsyncResource.runInAsyncScope
Protected
runTask function that will be executed.
-Input data for the task function.
-Protected
sendProtected
sendSends the list of task function names to the main worker.
+Sends task function names to the main worker.
Protected
Abstract
sendThe response message.
-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.
Whether the default task function was set or not.
-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
bindThe function to bind to the current execution context.
-Optional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
Optional
thisArg: ThisArgOptional
Optional
thisArg: ThisArgv14.8.0, v12.19.0
Inherited from AsyncResource.bind
Generated using TypeDoc
The type of async event.
-