X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FThreadWorker.html;h=db505c2403a9ecdf7e90f4b865b6f0b8d671354a;hb=d655c2c2b159a39f900230c14b301ba123653362;hp=507f44763b0f7070e43e26c44d8e42a0f198667a;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 507f4476..db505c24 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,13 +1,15 @@ -
Constructs a new poolifier thread worker.
Function 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.
Handler id of the aliveInterval
worker alive check.
Inherited from AbstractWorker.aliveInterval
Protected
Readonly
isWhether this is the main worker or not.
+Inherited from AbstractWorker.isMain
+Protected
lastInherited from AbstractWorker.lastTaskTimestamp
Protected
mainReference to main worker.
+Inherited from AbstractWorker.mainWorker
Readonly
optsProtected
Readonly
optsOptions for the worker.
Inherited from AbstractWorker.opts
Inherited from AbstractWorker.asyncId
Binds the given function to execute to this AsyncResource
's scope.
The returned function will have an asyncResource
property referencing
@@ -183,28 +196,28 @@ the AsyncResource
to which the function is bound.
The function to bind to the current AsyncResource
.
Inherited from AbstractWorker.bind
Protected
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
@@ -213,10 +226,10 @@ never be called.
A reference to asyncResource
.
Inherited from AbstractWorker.emitDestroy
Protected
getInherited from AbstractWorker.getMainWorker
Protected
handleHandle an error and convert it to a string so it can be sent back to the main worker.
+Handles an error and convert it to a string so it can be sent back to the main worker.
Message of the error.
Inherited from AbstractWorker.handleError
Protected
messageWorker message listener.
+Message received.
+Function processed by the worker when the pool's execution
function is invoked.
Inherited from AbstractWorker.messageListener
Protected
runRun the given function synchronously.
+Runs the given function synchronously.
Function that will be executed.
Optional
data: DataOptional
data: DataInput data for the given function.
Inherited from AbstractWorker.run
Protected
runRun the given function asynchronously.
+Runs the given function asynchronously.
Function that will be executed.
Optional
data: DataOptional
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 @@ -366,52 +385,52 @@ then restore the original execution context.
The function to call in the execution context of this async resource.
Rest
...args: any[]Optional
thisArg: ThisOptional
thisArg: ThisThe receiver to be used for the function call.
Rest
...args: any[]Optional arguments to pass to the function.
Inherited from AbstractWorker.runInAsyncScope
Protected
sendSend a message to the main worker.
+Sends a message to the main worker.
The response message.
Overrides AbstractWorker.sendToMainWorker
Inherited from AbstractWorker.triggerAsyncId
Static
bindBinds the given function to the current execution context.
The returned function will have an asyncResource
property referencing
@@ -439,14 +458,14 @@ the AsyncResource
to which the function is bound.
The function to bind to the current execution context.
AsyncResource
to which the function is bound.
An optional name to associate with the underlying AsyncResource
.
Optional
thisArg: ThisArgOptional
thisArg: ThisArgInherited from AbstractWorker.bind
Generated using TypeDoc
Type of data this worker receives from pool's execution. This can only be serializable data.
+