X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=a82edebe09444cd3162070324281c76882dfe812;hb=c065162cbd0458f984708314dcf5e80c7777077a;hp=567fbb14a97411fd6fd9b346b6191e9a77a16d32;hpb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 567fbb14..a82edebe 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
Protected
mainProtected
Readonly
mainReference to main worker.
Protected
Readonly
optsProtected
statisticsPerformance statistics computation.
+Performance statistics computation requirements.
Protected
taskAdds a task function to the worker. +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.
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.
Private
beginOptional
name: stringProtected
checkPrivate
checkPrivate
checkPrivate
checkPrivate
checkPrivate
endProtected
getPrivate
getGets the task function in the given scope.
+Gets the task function with the given name.
Optional
name: stringName of the function that will be returned.
+Name of the task function that will be returned.
Protected
handleThe error raised by the worker.
Message of the error.
+The error message.
+ +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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
Lists the names of the worker's task functions.
+The names of the worker's task functions.
Protected
messageRemoves 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.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the task function used as default task function.
Protected
runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+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 AsyncResource.runInAsyncScope
Protected
runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
+Task function that will be executed.
Protected
sendSends the ready response 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.
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.
Private
startStarts the worker check active interval.
+Private
stopStops the worker check active interval.
+Inherited from AsyncResource.triggerAsyncId
Private
updateStatic
bindInherited from AsyncResource.bind
Generated using TypeDoc
Type of data this worker receives from pool's execution. This can only be serializable data.
+Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
Response = unknown
-Type of response the worker sends back to the main worker. This can only be serializable data.
+Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
@@ -59,7 +59,8 @@
Properties
-Methods
-mainWorker: undefined | null | MainWorker
+mainWorker: MainWorker
Reference to main worker.
Properties
- Interval
-Protected
Optional
Readonly
aliveHandler id of the
+aliveInterval
worker alive check. Interval
+Protected
Optional
activeHandler id of the
activeInterval
worker activity check.
+Protected
Abstract
idWorker id.
+Protected
Readonly
isProtected
last