X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FThreadWorker.html;h=d65633c072faa517ffa82a3571c3c33141499547;hb=658b9aa08266ed9a8ae3c0fc947d237fa2674f09;hp=a4c0ee80c6aec47c63e2262922a1df9973a6456e;hpb=e83f3916315e18f3ca0c614d6ec9e064ab76c13c;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index a4c0ee80..d65633c0 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,13 +1,15 @@ -
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 thread. This can only be structured-cloneable data.
+Constructs a new poolifier thread worker.
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.
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.
+Inherited from AbstractWorker.isMain
+Protected
lastTimestamp of the last task processed by this worker.
-Inherited from AbstractWorker.lastTaskTimestamp
Protected
mainProtected
Readonly
mainReference to main worker.
+Inherited from AbstractWorker.mainWorker
Readonly
optsProtected
Readonly
optsOptions for the worker.
-Inherited from AbstractWorker.opts
Protected
statisticsPerformance statistics computation requirements.
+Inherited from AbstractWorker.statistics
+Protected
taskTask function(s) processed by the worker when the pool's execution
function is invoked.
Inherited from AbstractWorker.taskFunctions
+Protected
idThe unique asyncId
assigned to the resource.
Worker id.
Overrides AbstractWorker.id
+The unique asyncId
assigned to the resource.
Inherited from AbstractWorker.asyncId
Binds 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 AbstractWorker.bind
Protected
checkProtected
checkCheck to see if the worker should be terminated, because its living too long.
+Checks if the worker should be terminated, because its living too long.
Inherited from AbstractWorker.checkAlive
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
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 AbstractWorker.emitDestroy
Protected
getProtected
getReturns the main worker.
- -Reference to the main worker.
Reference to the main worker.
+ +Inherited from AbstractWorker.getMainWorker
Protected
handleProtected
handleHandle an error and convert it to a string so it can be sent back to the main worker.
- -Message of the error.
+Handles an error and convert it to a string so it can be sent back to the main worker.
The error raised by the worker.
-Inherited from AbstractWorker.handleError
-Protected
messageInherited from AbstractWorker.messageListener
+The error message.
+ +Overrides AbstractWorker.handleError
Protected
runProtected
messageRun the given function synchronously.
+Worker message listener.
Function that will be executed.
+Message received.
Optional
data: DataInput data for the given function.
-Inherited from AbstractWorker.run
+Inherited from AbstractWorker.messageListener
Protected
runProtected
runRun the given function asynchronously.
+Runs the given function asynchronously.
Function that will be executed.
Optional
data: DataInput data for the given function.
-Inherited from AbstractWorker.runAsync
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 AbstractWorker.runInAsyncScope
Protected
sendProtected
runSend a message to the main worker.
+Runs the given function synchronously.
Function that will be executed.
+Input data for the given function.
+Inherited from AbstractWorker.runSync
+Protected
sendSends a message to the main worker.
+The response message.
-Overrides AbstractWorker.sendToMainWorker
The same triggerAsyncId
that is passed to the AsyncResource
constructor.
The same triggerAsyncId
that is passed to the AsyncResource
constructor.
Inherited from AbstractWorker.triggerAsyncId
Static
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
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 AbstractWorker.bind
Generated using TypeDoc
Author
Alessandro Pio Ardizio
-Template
of data this worker receives from pool's execution. This can only be serializable data.
- -Template
of response the worker sends back to the main thread. This can only be serializable data.
- -Author
Alessandro Pio Ardizio
- -Since
0.0.1
+Since
0.0.1