X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=985aa787ff19bc7741a9cc97fa11a394930079b3;hb=1cc6e9ef64f399f4ca58da8079ef72a011ac4227;hp=770c6edb3ea27935d413a1d06fb4d35665240316;hpb=5a94e4b950eaf2234e07f87261ddea1482e839c6;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 770c6edb..985aa787 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,15 +1,15 @@ -
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 cluster 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
optsOptions for the worker.
-Inherited from AbstractWorker.opts
+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
idWorker id.
+Overrides AbstractWorker.id
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.
Inherited from AbstractWorker.asyncId
+The name of the task function to add.
+The task function to add.
+Whether the task function was added or not.
+ +Inherited from AbstractWorker.addTaskFunction
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.
The unique asyncId
assigned to the resource.
v14.8.0, v12.19.0
+Inherited from AbstractWorker.asyncId
+The function to bind to the current AsyncResource
.
Inherited from AbstractWorker.bind
-Protected
checkv14.8.0, v12.19.0
+Inherited from AbstractWorker.bind
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
.
Inherited from AbstractWorker.emitDestroy
+A reference to asyncResource
.
Inherited from AbstractWorker.emitDestroy
Protected
getProtected
getReturns the main worker.
- -Reference to the main worker.
Inherited from AbstractWorker.getMainWorker
+Reference to the main worker.
+ +https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+Inherited from AbstractWorker.getMainWorker
Protected
handleProtected
handle{@inheritDoc}
+Handles an error and convert it to a string so it can be sent back to the main worker.
Overrides AbstractWorker.handleError
+The error raised by the worker.
+The error message.
+ +Inherited from AbstractWorker.handleError
Protected
messageProtected
handleHandles a kill message sent by the main worker.
+The kill message.
+Inherited from AbstractWorker.handleKillMessage
+Protected
handleHandles the ready message sent by the main worker.
+The ready message.
+Overrides AbstractWorker.handleReadyMessage
+Protected
handleInherited from AbstractWorker.messageListener
+Inherited from AbstractWorker.handleTaskFunctionOperationMessage
Protected
runRuns the given function synchronously.
+Checks if the worker has a task function with the given name.
Function that will be executed.
+The name of the task function to check.
Whether the worker has a task function with the given name or not.
+ +Inherited from AbstractWorker.hasTaskFunction
+Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Inherited from AbstractWorker.listTaskFunctionNames
+Protected
messageWorker message listener.
+Optional
data: DataThe received message.
+Inherited from AbstractWorker.messageListener
+Removes a task function from the worker.
+Input data for the given function.
-Inherited from AbstractWorker.run
+The name of the task function to remove.
+Whether the task function existed and was removed or not.
+ +Inherited from AbstractWorker.removeTaskFunction
Protected
runProtected
runRuns the given function asynchronously.
+Runs the given task.
Function that will be executed.
+The task to execute.
Inherited from AbstractWorker.run
+Protected
runRuns the given task function asynchronously.
+Optional
data: DataTask function that will be executed.
+Input data for the given function.
-Inherited from AbstractWorker.runAsync
+Input data for the task 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.
-Inherited from AbstractWorker.runInAsyncScope
-Protected
sendv9.6.0
+Inherited from AbstractWorker.runInAsyncScope
+Protected
run{@inheritDoc}
+Runs the given task function synchronously.
Overrides AbstractWorker.sendToMainWorker
+Task function that will be executed.
+Input data for the task function.
+Inherited from AbstractWorker.runSync
Protected
sendThe same triggerAsyncId
that is passed to the AsyncResource
constructor.
Sends task function names to the main worker.
Inherited from AbstractWorker.triggerAsyncId
+Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
Static
bindProtected
sendBinds 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.
Sends a message to main worker.
+The response message.
+Overrides AbstractWorker.sendToMainWorker
+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.
+ +Inherited from AbstractWorker.setDefaultTaskFunction
+The same triggerAsyncId
that is passed to the AsyncResource
constructor.
v14.8.0, v12.19.0
+Inherited from AbstractWorker.triggerAsyncId
+Static
bindThe function to bind to the current execution context.
-Optional
type: stringOptional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
thisArg: ThisArgInherited from AbstractWorker.bind
+Optional
thisArg: ThisArgv14.8.0, v12.19.0
+Inherited from AbstractWorker.bind
Generated using TypeDoc
Generated using TypeDoc
Author
Christopher Quadflieg
-Author
Christopher Quadflieg
- -Since
2.0.0
+Since
2.0.0