X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=c406ecd67552eab152df3c3e7a54534890f0ab40;hb=0743823772420af0e3ada63d8a547c7c4c22b836;hp=2d650398b30c7c574d7479c24dd129d83199e475;hpb=afa30fd0dd5bbc5d305cc30be663966a449efc08;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 2d650398..c406ecd6 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,661 +1,99 @@ -
Abstract
Type of main worker.
-Type of data this worker receives from pool's execution. This can only be serializable data.
-Type of response the worker sends back to the main worker. This can only be serializable data.
-Abstract
Base class that implements some shared logic for all poolifier workers.
+Type of main worker.
+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 structured-cloneable data.
+Constructs a new poolifier worker.
-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.
-Options for the worker.
-Protected
Optional
Readonly
aliveHandler id of the aliveInterval
worker alive check.
Protected
Readonly
isWhether this is the main worker or not.
-Protected
lastTimestamp of the last task processed by this worker.
-Protected
mainReference to main worker.
-Protected
Readonly
optsOptions for the worker.
-Protected
statisticsPerformance statistics computation.
-Protected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
Private
beginProtected
checkPrivate
checkChecks if the taskFunctions
parameter is passed to the constructor.
The task function(s) parameter that should be checked.
-Private
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
.
Private
endProtected
getPrivate
getGets the task function in the given scope.
-Optional
name: stringName of the function that will be returned.
-Protected
handleProtected
messageWorker message listener.
-Message received.
-Protected
runRuns the given function asynchronously.
-Function that will be executed.
-Input data for the given 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.
-The function to call in the execution context of this async resource.
-Rest
...args: any[]Optional
thisArg: ThisThe receiver to be used for the function call.
-Rest
...args: any[]Optional arguments to pass to the function.
-v9.6.0
-Protected
runRuns the given function synchronously.
-Function that will be executed.
-Input data for the given function.
-Protected
Abstract
sendSends a message to the main worker.
-The response message.
-Static
bindBinds the given function to the current execution context.
-The function to bind to the current execution context.
-Optional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
thisArg: ThisArgv14.8.0, v12.19.0
-Generated using TypeDoc
Constructs a new poolifier worker.
+Whether this is the main worker or not.
+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
activeHandler id of the activeInterval
worker activity check.
Protected
Abstract
idWorker id.
+Protected
Readonly
isWhether this is the main worker or not.
+Protected
lastTimestamp of the last task processed by this worker.
+Private
Readonly
mainReference to main worker.
+Protected
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.
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.
+Private
beginOptional
name: stringPrivate
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
checkChecks if the taskFunctions
parameter is passed to the constructor and valid.
The task function(s) parameter that should be checked.
+Private
checkPrivate
endProtected
getReturns the main worker.
+Reference to the main worker.
+https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+Protected
handleProtected
handleHandles a kill message sent by the main worker.
+Protected
Abstract
handleHandles the ready message sent by the main worker.
+The ready message.
+Protected
handleChecks 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.
+Protected
messageWorker message listener.
+The received message.
+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.
+Protected
Readonly
runRuns the given task.
+The task to execute.
+Protected
Readonly
runRuns the given task function asynchronously.
+Task function that will be executed.
+Input data for the task function.
+Protected
Readonly
runRuns the given task function synchronously.
+Task function that will be executed.
+Input data for the task function.
+Protected
sendProtected
Abstract
sendSends a message to main worker.
+The response message.
+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.
+Private
startPrivate
stopPrivate
updateGenerated using TypeDoc
Base class that implements some shared logic for all poolifier workers.
-