X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=59513293917ffae5afc5480aa914530a871b7465;hb=6c7d45d0e98d9849cfa99fe8d0aa567c989d049f;hp=48c9fffa9099a75acb763e38b6dfa89918273255;hpb=52f4e8137eab5d72c663eb9ae9289c08d804e559;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 48c9fffa..59513293 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,13 +1,13 @@ -
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.
Adds a task function to the worker. If a task function with the same name already exists, it is replaced.
@@ -223,22 +227,16 @@ If a task function with the same name already exists, it is replaced.The task function to add.
Whether 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.
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 AbstractWorker.asyncId
Inherited from AbstractWorker.bind
Inherited from AbstractWorker.emitDestroy
Protected
getReference to the main worker.
-https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+Inherited from AbstractWorker.getMainWorker
Protected
handleOverrides AbstractWorker.handleError
Protected
handleHandles a kill message sent by the main worker.
+Overrides AbstractWorker.handleKillMessage
+Protected
handleHandles the ready message sent by the main worker.
+The 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.
Inherited from AbstractWorker.hasTaskFunction
Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Inherited from AbstractWorker.listTaskFunctionNames
+Protected
messageInherited 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.
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
runRuns the given task.
+The task to execute.
+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.
Inherited from AbstractWorker.runAsync
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.
Inherited from AbstractWorker.runSync
Protected
sendSends task function names to the main worker.
+Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
+Protected
sendSends a message to the main worker.
+Sends a message to main worker.
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.
+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-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.
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
bindInherited from AbstractWorker.bind
Generated using TypeDoc
Generated using TypeDoc
Task function(s) processed by the worker when the pool's
execution
function is invoked.