X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FThreadWorker.html;h=a425fbf372a4d2c9a8a4beaaad647aa440c335c1;hb=8cc4ea811611b8ad77c7b0379911afe497f2e7e4;hp=8e60862cfa364104018d0809b4affc48dcb4f6ad;hpb=06fa9e0de6b62965c9dd2fe6023e943f35775026;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 8e60862c..a425fbf3 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -
If you use a DynamicThreadPool
the extra workers that were created will be terminated,
but the minimum number of workers will be guaranteed.
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 thread. This can only be serializable 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
lastProtected
lastTimestamp of the last task processed by this worker.
-Inherited from AbstractWorker.lastTaskTimestamp
Protected
mainReference to main worker.
-Inherited from AbstractWorker.mainWorker
-Protected
Readonly
optsProtected
Readonly
optsOptions for the worker.
-Inherited from AbstractWorker.opts
Private
portMessage port used to communicate with the main worker.
+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.
+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 or an empty 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
+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
.
Inherited from AbstractWorker.bind
-Protected
checkChecks if the worker should be terminated, because its living too long.
Inherited from AbstractWorker.checkAlive
+v14.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
.
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
handleHandles an error and convert it to a string so it can be sent back to the main worker.
- -Message of the error.
The error raised by the worker.
-Inherited from AbstractWorker.handleError
-Protected
messageThe error message.
+ +Overrides AbstractWorker.handleError
+Protected
handleWorker message listener.
+Handles a kill message sent by the main worker.
Message received.
-Function processed by the worker when the pool's execution
function is invoked.
The kill message.
Overrides AbstractWorker.handleKillMessage
+Protected
handleInherited from AbstractWorker.messageListener
+The ready message.
+Overrides AbstractWorker.handleReadyMessage
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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
Inherited from AbstractWorker.hasTaskFunction
+Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Inherited from AbstractWorker.listTaskFunctions
+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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty 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
runProtected
runRuns the given function asynchronously.
+Runs the given task.
Function that will be executed.
+The task to execute.
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+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.
-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.
-v9.6.0
+Inherited from AbstractWorker.runInAsyncScope
Protected
sendProtected
runSends a message to the main worker.
+Runs the given task function synchronously.
Task function that will be executed.
+Input data for the task function.
+Inherited from AbstractWorker.runSync
+Protected
sendSends the list of task function names to the main worker.
+Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+Protected
sendSends a message to main worker.
+The response message.
-Overrides AbstractWorker.sendToMainWorker
The same triggerAsyncId
that is passed to the AsyncResource
constructor.
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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty 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
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
-Author
Alessandro Pio Ardizio
- -Since
0.0.1
+Since
0.0.1