X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractWorker.html;h=71c0015fed848d4f0855ec42e200be72e7a953e3;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=2d650398b30c7c574d7479c24dd129d83199e475;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 2d650398..71c0015f 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
Protected
lastProtected
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
beginProtected
checkPrivate
checkChecks if the worker should be terminated, because its living too long.
@@ -260,7 +310,15 @@Private
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.
Protected
messageMessage received.
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.
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.
Function that will be executed.
+Task function that will be executed.
Inherited from AsyncResource.runInAsyncScope
Protected
runRuns the given function synchronously.
Function that will be executed.
+Task function that will be executed.
Protected
Abstract
sendThe response message.
Sets the default task function to use when no task function name is specified.
+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 alive check interval.
+Private
stopStops the worker alive check interval.
+Inherited from AsyncResource.triggerAsyncId
Protected
workerNotifies the main worker that this worker is ready to process tasks.
+Static
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.
@@ -60,6 +60,7 @@
alive Interval?
+id
is Main
last Task Timestamp
main Worker
@@ -69,10 +70,12 @@
async Id
+add Task Function
+async Id
begin Task Performance
bind
-check Alive
+check Alive
+check Statistics
check Task Functions
check Worker Options
emit Destroy
@@ -80,12 +83,19 @@
get Main Worker
get Task Function
handle Error
+has Task Function
message Listener
+remove Task Function
+run
run Async
run In Async Scope
run Sync
send To Main Worker
+set Default Task Function
+start Check Alive
+stop Check Alive
trigger Async Id
+worker Ready
bind
Properties
Methods
-mainWorker: undefined | null | MainWorker
+mainWorker: MainWorker
Reference to main worker.
Properties
Interval
+Protected
Optional
Readonly
aliveProtected
Optional
aliveHandler id of the
aliveInterval
worker alive check.
+Protected
Abstract
idWorker id.
+Protected
Readonly
is