X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=3d1f94e5db28f6a06da7395b9ec9de6469e094ef;hb=e0b200de6e1222b791497942f655b8491d28fa23;hp=7d135a5d4c62b1ec643daa1745670febf4cb1ebd;hpb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 7d135a5d..3d1f94e5 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,13 +1,13 @@ -
Options for the worker.
-Protected
Readonly
isProtected
lastProtected
optsPrivate
portProtected
statisticsProtected
taskAdds a task function to the worker. If a task function with the same name already exists, it is replaced.
@@ -221,23 +224,19 @@ 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 AbstractWorker.asyncId
The function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
Inherited from AbstractWorker.bind
Inherited from AbstractWorker.emitDestroy
Protected
getInherited from AbstractWorker.getMainWorker
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.
Overrides AbstractWorker.handleError
Protected
handleThe kill message.
-Overrides AbstractWorker.handleKillMessage
Protected
handleThe ready message.
-Overrides AbstractWorker.handleReadyMessage
Protected
handleInherited from AbstractWorker.handleTaskFunctionOperationMessage
+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.
+ + +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
Lists the names of the worker's task functions.
The names of the worker's task functions.
Inherited from AbstractWorker.listTaskFunctions
+Inherited from AbstractWorker.listTaskFunctionNames
Protected
messageThe 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.
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.
Inherited from AbstractWorker.removeTaskFunction
Protected
runThe task to execute.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
-Inherited from AbstractWorker.run
Protected
runTask function that will be executed.
-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
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 AbstractWorker.runInAsyncScope
Protected
runTask function that will be executed.
-Input data for the task function.
-Inherited from AbstractWorker.runSync
Protected
sendProtected
sendSends the list of task function names to the main worker.
+Sends task function names to the main worker.
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
Protected
sendThe 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.
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.
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
Optional
thisArg: ThisArgv14.8.0, v12.19.0
Inherited from AbstractWorker.bind
Generated using TypeDoc
Task function(s) processed by the worker when the pool's
-execution
function is invoked.