X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=b29b5f35df304a9632c2dca952421cdba5179c09;hb=019581cc38fe0b47645d9b2120f325ab37388be2;hp=71c0015fed848d4f0855ec42e200be72e7a953e3;hpb=a15339d10554e3130fa1d8957163cb29a8eb2c41;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 71c0015f..b29b5f35 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
Task function(s) processed by the worker when the pool's execution
function is invoked. The first function is the default function.
Reference to main worker.
Reference to main worker.
+Task function(s) processed by the worker when the pool's execution
function is invoked. The first function is the default function.
Protected
Optional
aliveHandler id of the aliveInterval
worker alive check.
Protected
Optional
activeHandler id of the activeInterval
worker activity check.
Protected
Abstract
idProtected
Readonly
isProtected
lastProtected
Readonly
mainPrivate
Readonly
mainReference to main worker.
Protected
Readonly
optsProtected
statisticsProtected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
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.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Private
beginOptional
name: stringPrivate
checkPrivate
checkPrivate
checkCheck if the message worker id is set and matches the worker id.
+The message to check.
+https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
+Private
checkPrivate
checkThe task function(s) parameter that should be checked.
Private
checkPrivate
endProtected
getPrivate
getGets the task function with the given name.
Name of the task function that will be returned.
The task function.
+The task function.
https://nodejs.org/api/errors.html#class-error If the task function is not found.
Protected
handleProtected
handleHandles a kill message sent by the main worker.
+The kill message.
+Protected
Abstract
handleHandles the ready message sent by the main worker.
+The ready message.
+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.
Protected
messageWhether 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.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the task function used as default task function.
Protected
runhttps://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.
Task function that will be executed.
Protected
runRuns the given function synchronously.
+Runs the given task function synchronously.
Task function that will be executed.
Protected
sendProtected
Abstract
sendSends a message to the main worker.
+Sends a message to main worker.
Sets the default task function to use when no task function name is specified.
+Sets the default task function to use in the worker.
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.
https://nodejs.org/api/errors.html#class-error If the name
parameter is a non-existing task function.
Private
startPrivate
startStarts the worker alive check interval.
+Starts the worker check active interval.
Private
stopPrivate
stopStops the worker alive check interval.
+Stops the worker check active interval.
Protected
workerPrivate
updateStatic
bindInherited from AsyncResource.bind
Constructs a new poolifier worker.