X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=3a9a473cacbd623a973466bed1203856fccde754;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=8c0f1bf25e7c7d68dff8c7037c2456cad6d1b9c4;hpb=e604957d6ec7c137a3588de2ebbc9c83c0f634ba;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 8c0f1bf2..3a9a473c 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -
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
Readonly
isWhether this is the main worker or not.
-Inherited from AbstractWorker.isMain
+Inherited from AbstractWorker.isMain
Protected
lastProtected
lastTimestamp of the last task processed by this worker.
-Inherited from AbstractWorker.lastTaskTimestamp
+Inherited from AbstractWorker.lastTaskTimestamp
Protected
mainProtected
Readonly
mainReference to main worker.
-Inherited from AbstractWorker.mainWorker
+Inherited from AbstractWorker.mainWorker
Readonly
optsProtected
Readonly
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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
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.
+ +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
messageChecks 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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
Inherited from AbstractWorker.hasTaskFunction
+Protected
messageInherited from AbstractWorker.messageListener
+Message received.
+Inherited from AbstractWorker.messageListener
Protected
runRuns the given function synchronously.
+Removes a task function from the worker.
Function that will be executed.
+The name of the task function to remove.
Whether the task function existed and was removed or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the task function used as default task function.
Inherited from AbstractWorker.removeTaskFunction
+Protected
runInput data for the given function.
-Inherited from AbstractWorker.run
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Inherited from AbstractWorker.run
Protected
runProtected
runRuns the given function asynchronously.
Function that will be executed.
+Task function that will be executed.
Optional
data: DataInput 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
+ + +v9.6.0
+Inherited from AbstractWorker.runInAsyncScope
+Protected
runRuns the given function synchronously.
+Task function that will be executed.
+Input data for the task function.
+Inherited from AbstractWorker.runSync
Protected
sendProtected
send{@inheritDoc}
+Sends a message to the main worker.
Overrides AbstractWorker.sendToMainWorker
+The response message.
+Overrides AbstractWorker.sendToMainWorker
Sets the default task function to use when no task function name is specified.
+The name of the task function to use as default task function.
+Whether the default task function was set or not.
+The same triggerAsyncId
that is passed to the AsyncResource
constructor.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name
parameter is a non-existing task function.
Inherited from AbstractWorker.setDefaultTaskFunction
+The same triggerAsyncId
that is passed to the AsyncResource
constructor.
Inherited from AbstractWorker.triggerAsyncId
+Protected
workerNotifies the main worker that this worker is ready to process tasks.
Inherited from AbstractWorker.triggerAsyncId
+Inherited from AbstractWorker.workerReady
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: ThisArgInherited from AbstractWorker.bind
+Optional
thisArg: ThisArgv14.8.0, v12.19.0
+Inherited from AbstractWorker.bind
Generated using TypeDoc
Author
Christopher Quadflieg
-Author
Christopher Quadflieg
- -Since
2.0.0
+Since
2.0.0