X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FThreadWorker.html;h=7d135a5d4c62b1ec643daa1745670febf4cb1ebd;hb=b4c2a50df77a5f3110d228436ce9f3008cbd8297;hp=d247ec0492c4922e295bb3a1787483a69e910e18;hpb=3557031d88b5ff00ea86695728b3ba3af46e9faa;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index d247ec04..7d135a5d 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -
Options for the worker.
-Protected
Optional
aliveHandler id of the aliveInterval
worker alive check.
Protected
Optional
activeHandler id of the activeInterval
worker activity check.
Protected
Readonly
isProtected
lastProtected
Readonly
mainReference to main worker.
-Protected
Readonly
optsProtected
optsOptions for the worker.
Private
portMessage 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
handleHandles a kill message sent by the main worker.
+The kill message.
+Overrides AbstractWorker.handleKillMessage
+Protected
handleHandles the ready message sent by the main worker.
+The 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
Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Inherited from AbstractWorker.listTaskFunctions
+Protected
messageMessage received.
-The 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
runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Inherited from AbstractWorker.run
+Protected
runRuns the given function asynchronously.
+Runs the given task function asynchronously.
Function that will be executed.
-Task function that will be executed.
+Input data for the given function.
-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
runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
-Task function that will be executed.
+Input data for the given function.
-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
Sets the default task function to use when no task function name is specified.
+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.
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
Protected
workerNotifies the main worker that this worker is ready to process tasks.
-Inherited from AbstractWorker.workerReady
-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.