X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractWorker.html;h=50ac5c495c6477a8c881eac8d0e9436004fc0648;hb=b4c2a50df77a5f3110d228436ce9f3008cbd8297;hp=869e9ee7f7bfc2908345915583ee5135735daf59;hpb=68887e30ceca3df78b70e0b8f1b262a76f2d7cd8;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 869e9ee7..50ac5c49 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
The type of async event.
-Whether this is the main worker or not.
-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.
-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
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.
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-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: stringOptional
name: stringOptional
The function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
Private
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.
-Private
getProtected
handleGets the task function in the given scope.
+Handles an error and convert it to a string so it can be sent back to the main worker.
Optional
name: stringName of the task function that will be returned.
-The error raised by the worker.
+The error message.
+Protected
handleProtected
handleHandles an error and convert it to a string so it can be sent back to the main worker.
+Handles a kill message sent by the main worker.
Protected
Abstract
handleThe error message.
- +The ready message.
+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.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Protected
messageMessage received.
-The received message.
+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-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.
+Input data for the given function.
-Input data for the task function.
+The function to call in the execution context of this async resource.
Rest
...args: any[]Rest
...args: any[]Rest
Optional
thisArg: ThisThe receiver to be used for the function call.
-Optional
Rest
...args: any[]Optional arguments to pass to the function.
-Rest
v9.6.0
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
sendProtected
Abstract
sendSends a message to the main worker.
+Sends a message to main worker.
The response message.
-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.
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.
Inherited from AsyncResource.triggerAsyncId
Protected
workerPrivate
updateNotifies the main worker that this worker is ready to process tasks.
-Static
bindThe function to bind to the current execution context.
-Optional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
Optional
thisArg: ThisArgOptional
thisArg: ThisArgOptional
v14.8.0, v12.19.0
Inherited from AsyncResource.bind
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Constructs a new poolifier worker.