X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=71c0015fed848d4f0855ec42e200be72e7a953e3;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=4ab8a26e71a842599ee5d0c50003bbbb4bd7f466;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 4ab8a26e..71c0015f 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
Abstract
Type of main worker.
-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.
+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.
+Constructs a new poolifier worker.
The type of async event.
-Whether this is the main worker or not.
-Function processed by the worker when the pool's execution
function is invoked.
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.
-Options for the worker.
-Overrides AsyncResource.constructor
Protected
Optional
Readonly
aliveProtected
Optional
aliveHandler id of the aliveInterval
worker alive check.
Protected
Readonly
isProtected
Abstract
idWorker id.
+Protected
Readonly
isWhether this is the main worker or not.
-Protected
lastProtected
lastTimestamp of the last task processed by this worker.
-Protected
mainProtected
Readonly
mainReference to main worker.
-Protected
Readonly
optsProtected
Readonly
optsOptions for the worker.
-Protected
statisticsPerformance statistics computation requirements.
+Protected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
The unique asyncId
assigned to the resource.
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.
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: stringBinds the given function to execute to this AsyncResource
's scope.
The returned function will have an asyncResource
property referencing
-the AsyncResource
to which the function is bound.
v14.8.0, v12.19.0
The function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
+Inherited from AsyncResource.bind
Protected
checkPrivate
checkChecks if the worker should be terminated, because its living too long.
Private
checkPrivate
checkPrivate
checkChecks if the fn
parameter is passed to the constructor.
Checks if the taskFunctions
parameter is passed to the constructor.
The function that should be defined.
+The task function(s) parameter that should be checked.
Private
checkPrivate
checkCall all destroy
hooks. This should only ever be called once. An error will
be thrown if it is called more than once. This must be manually called. If
the resource is left to be collected by the GC then the destroy
hooks will
never be called.
A reference to asyncResource
.
A reference to asyncResource
.
Inherited from AsyncResource.emitDestroy
Protected
getPrivate
endProtected
getReturns the main worker.
- -Reference to the main worker.
Reference to the main worker.
+ +Protected
handlePrivate
getHandles an error and convert it to a string so it can be sent back to the main worker.
- -Message of the error.
+Gets the task function with the given name.
The error raised by the worker.
-Protected
messageOptional
name: stringName of the task function that will be returned.
+The task function.
+ +https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Protected
handleWorker message listener.
+Handles an error and convert it to a string so it can be sent back to the main worker.
Message received.
-Function processed by the worker when the pool's execution
function is invoked.
The error raised by the worker.
The error 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.
Protected
runProtected
messageRuns the given function synchronously.
+Worker message listener.
Function that will be executed.
+Message received.
Removes a task function from the worker.
+Optional
data: DataInput data for the given function.
-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
runProtected
runRuns the given function asynchronously.
+Runs the given task.
Function that will be executed.
+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.
+Optional
data: DataTask function that will be executed.
+Input data for the given function.
-Input data for the task function.
+Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.
- -v9.6.0
The function to call in the execution context of this async resource.
Rest
...args: any[]Rest
...args: any[]Optional
thisArg: ThisOptional
thisArg: ThisThe receiver to be used for the function call.
-Rest
...args: any[]Rest
...args: any[]Optional arguments to pass to the function.
-v9.6.0
+Inherited from AsyncResource.runInAsyncScope
Protected
Abstract
sendProtected
runRuns the given function synchronously.
+Task function that will be executed.
+Input data for the task function.
+Protected
Abstract
sendSends a message to the main worker.
The 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.
+The same triggerAsyncId
that is passed to the AsyncResource
constructor.
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.
+Static
bindProtected
workerNotifies the main worker that this worker is ready to process tasks.
+Static
bindBinds the given function to the current execution context.
-The returned function will have an asyncResource
property referencing
-the AsyncResource
to which the function is bound.
v14.8.0, v12.19.0
The function to bind to the current execution context.
-Optional
type: stringOptional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
thisArg: ThisArgOptional
thisArg: ThisArgv14.8.0, v12.19.0
+Inherited from AsyncResource.bind
Generated using TypeDoc
Base class that implements some shared logic for all poolifier workers.
-