X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractWorker.html;h=88a14d30474e85cb9245a5b6bb76743a811b50d2;hb=658b9aa08266ed9a8ae3c0fc947d237fa2674f09;hp=460aac9df0eb0d25f61fdfaa12a766b43df5de46;hpb=1e8c193fa4e519921b6db1b0d9d443cb15ecf12a;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 460aac9d..88a14d30 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.
-Protected
Optional
Readonly
aliveProtected
Optional
aliveHandler id of the aliveInterval
worker alive check.
Protected
Abstract
idWorker id.
+Protected
Readonly
isProtected
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.
Private
beginBinds 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
AsyncResource
to which the function is bound.
The function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
+Inherited from AsyncResource.bind
Protected
checkProtected
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
checkAsyncResource
to which the function is bound.
Call 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
@@ -252,25 +318,59 @@ the resource is left to be collected by the GC then the destroy
hoo
never be called.
A reference to asyncResource
.
Inherited from AsyncResource.emitDestroy
Private
endProtected
getProtected
getReturns the main worker.
Reference to the main worker.
-Private
getGets the task function in the given scope.
+Optional
name: stringName of the function that will be returned.
+Protected
handleProtected
handleHandles an error and convert it to a string so it can be sent back to the main worker.
The error raised by the worker.
-Message of the error.
-The error message.
+ +Protected
messageProtected
messageWorker message listener.
Message received.
-Function processed by the worker when the pool's execution
function is invoked.
Protected
runRuns the given function synchronously.
Function that will be executed.
-Input data for the given function.
-Protected
runProtected
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.
- -v9.6.0
The function to call in the execution context of this async resource.
Optional
thisArg: ThisThe receiver to be used for the function call.
-Rest
...args: any[]Optional arguments to pass to the function.
-v9.6.0
+Inherited from AsyncResource.runInAsyncScope
Protected
runRuns the given function synchronously.
+Function that will be executed.
+Input data for the given function.
+Protected
Abstract
sendProtected
Abstract
sendSends a message to the main worker.
The response message.
-Private
startStatic
bindStatic
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
AsyncResource
to which the function is bound.
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
+Inherited from AsyncResource.bind
Generated using TypeDoc
Base class that implements some shared logic for all poolifier workers.
-