X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FThreadWorker.html;h=7d135a5d4c62b1ec643daa1745670febf4cb1ebd;hb=b4c2a50df77a5f3110d228436ce9f3008cbd8297;hp=a6a200fbd4a044f43ec626a73f7740e148951e2d;hpb=76b46937556ea55049d5c413aa0a77d0c7f47f48;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index a6a200fb..7d135a5d 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -
Options for the worker.
-Protected
Readonly
isProtected
lastProtected
Readonly
optsProtected
optsOptions for the worker.
Private
portMessage port used to communicate with the main thread.
+Message port used to communicate with the main worker.
Protected
statisticsProtected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
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-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.
The function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
Protected
getReference to the main worker.
-Protected
handleThe 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
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.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
Inherited from AbstractWorker.hasTaskFunction
Inherited from AbstractWorker.listTaskFunctions
Protected
messageThe received message.
-Inherited from AbstractWorker.messageListener
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-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.
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
...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
runTask function that will be executed.
-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
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-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.
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.