X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=c3a79eecdf9d5a71e8b0258e53321f43a4f97bbf;hb=4cb259d3e1837759b8bac901d3755f1610b5ddc4;hp=6fc6317e816e96bc864be48fb1a3bd89baec86c0;hpb=20ebfb03d96dc805e59643cf1f90667545a3fef2;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 6fc6317e..c3a79eec 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -
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.
Options for the worker.
Protected
Optional
Readonly
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
optsOptions for the 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.
+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 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: stringProtected
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
checkPrivate
checkThe task function(s) parameter that should be checked.
Private
checkPrivate
checkPrivate
endProtected
getReference to the main worker.
+https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+Protected
handlePrivate
getProtected
handleGets the task function in the given scope.
+Handles a kill message sent by the main worker.
Optional
name: stringName of the function that will be returned.
+The kill message.
Protected
handleProtected
Abstract
handleHandles an error and convert it to a string so it can be sent back to the main worker.
+Handles the ready message sent by the main worker.
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 or an empty string.
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 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
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.
Protected
runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
+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 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 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
stopPrivate
updateStatic
bindGenerated using TypeDoc
Generated using TypeDoc
Constructs a new poolifier worker.