X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FClusterWorker.html;h=cc900af0538b1f61747c09fb5e64eae92c50ebce;hb=896624ae5d3cb6861b202a4c3b1d4c42368868c5;hp=ea603c4f1811029915895e0b9ec49393a042c2c8;hpb=273b76d87560482b4114668a705e42d54b3ce3b0;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index ea603c4f..cc900af0 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.
2.0.0
Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
-Constructs a new poolifier cluster worker.
+Constructs a new poolifier cluster worker.
Task function(s) processed by the worker when the pool's execution
function is invoked.
Options for the worker.
-Protected
Optional
activeHandler id of the activeInterval
worker activity check.
Protected
Readonly
isWhether this is the main worker or not.
-Protected
lastTimestamp of the last task processed by this worker.
-Protected
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.
Protected
idWorker id.
-Adds a task function to the worker. +
Protected
Optional
activeHandler id of the activeInterval
worker activity check.
Protected
Readonly
isWhether this is the main worker or not.
+Protected
lastTimestamp of the last task processed by this worker.
+Protected
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.
Protected
idWorker id.
+Adds a task function to the worker. If a task function with the same name already exists, it is replaced.
The name of the task function to add.
The task function to add.
Whether the task function was added or not.
-Binds the given function to execute to this AsyncResource
's scope.
Call all destroy
hooks. This should only ever be called once. An error will
+
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
.
Protected
getReturns the main worker.
+Protected
getReturns the main worker.
Reference to the main worker.
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-Protected
handleProtected
handleProtected
handleHandles a kill message sent by the main worker.
-Protected
handleHandles the ready message sent by the main worker.
+Protected
handleHandles a kill message sent by the main worker.
+Protected
handleHandles the ready message sent by the main worker.
The ready message.
-Protected
handleChecks if the worker has a task function with the given name.
+Protected
handleChecks 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.
-Lists the names of the worker's task functions.
+Protected
messageWorker message listener.
+Protected
messageWorker message listener.
The received message.
-Removes a task function from the worker.
+Removes a task function from the worker.
The name of the task function to remove.
Whether the task function existed and was removed or not.
-Protected
runRuns the given task.
+Protected
runRuns the given task.
The task to execute.
-Protected
runProtected
runRuns the given task function asynchronously.
Task function that will be executed.
Input data for the task 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.
@@ -93,17 +93,17 @@ then restore the original execution context.Rest
...args: any[]Optional
thisArg: ThisThe receiver to be used for the function call.
Rest
...args: any[]Optional arguments to pass to the function.
v9.6.0
-Protected
runProtected
runRuns the given task function synchronously.
Task function that will be executed.
Input data for the task function.
-Protected
sendProtected
sendProtected
sendProtected
sendSends a message to main worker.
The response message.
-Sets the default task function to use in the worker.
+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.
-Static
bindBinds the given function to the current execution context.
+Static
bindBinds the given function to the current execution context.
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
Type of data this worker receives from pool's execution. This can only be structured-cloneable data.