X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2Fthreadworker.html;h=60bd61710c53494e310b1b10ba7d7de550dc68fc;hb=refs%2Ftags%2Fv2.2.0;hp=07bef40c121b5302a231ccedb2a876e6f194996d;hpb=849e05470ba75db08bb8def0c547ab4d8c35c9a0;p=poolifier.git diff --git a/docs/classes/threadworker.html b/docs/classes/threadworker.html index 07bef40c..60bd6171 100644 --- a/docs/classes/threadworker.html +++ b/docs/classes/threadworker.html @@ -1,942 +1,83 @@ - - -
- - -Type of data this worker receives from pool's execution. This can only be serializable data.
-Type of response the worker sends back to the main thread. This can only be serializable data.
-Constructs a new poolifier thread worker.
-Function processed by the worker when the pool's execution
function is invoked.
Options for the worker.
-Whether the worker is working asynchronously or not.
-Handler ID of the interval
alive check.
The kill behavior set as option on the Worker constructor or a default value.
-Timestamp of the last task processed by this worker.
-The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires.
-the unique ID assigned to this AsyncResource instance.
-Binds the given function to execute to this AsyncResource
's scope.
The function to bind to the current AsyncResource
.
Check to see if the worker should be terminated, because its living too long.
-Call AsyncHooks destroy callbacks.
-Returns the main worker.
-Reference to the main worker.
-Handle an error and convert it to a string so it can be sent back to the main worker.
-The error raised by the worker.
-Message of the error.
-Run the given function synchronously.
-Function that will be executed.
-Input data for the given function.
-Run the given function asynchronously.
-Function that will be executed.
-Input data for the given 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.
-The function to call in the execution context of this - async resource.
-The receiver to be used for the function call.
-Optional arguments to pass to the function.
-the trigger ID for this AsyncResource instance.
-Binds the given function to the current execution context.
-The function to bind to the current execution context.
-An optional name to associate with the underlying AsyncResource
.
Generated using TypeDoc
-A thread worker used by a poolifier ThreadPool
.
When this worker is inactive for more than the given maxInactiveTime
,
+it will send a termination request to its main thread.
If you use a DynamicThreadPool
the extra workers that were created will be terminated,
+but the minimum number of workers will be guaranteed.
Constructs a new poolifier thread worker.
+Function processed by the worker when the pool's execution
function is invoked.
Options for the worker.
+Handler Id of the aliveInterval
worker alive check.
Timestamp of the last task processed by this worker.
+The unique asyncId
assigned to the resource.
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 function to bind to the current AsyncResource
.
Check to see if the worker should be terminated, because its living too long.
+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
.
Returns the main worker.
+Reference to the main worker.
+Handle an error and convert it to a string so it can be sent back to the main worker.
+The error raised by the worker.
+Message of the error.
+Run the given function synchronously.
+Function that will be executed.
+Input data for the given function.
+Run the given function asynchronously.
+Function that will be executed.
+Input data for the given 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.
+The function to call in the execution context of this async resource.
+The receiver to be used for the function call.
+Optional arguments to pass to the function.
+Send a message to the main worker.
+The response message.
+The same triggerAsyncId
that is passed to the AsyncResource
constructor.
Binds 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.
The function to bind to the current execution context.
+An optional name to associate with the underlying AsyncResource
.
Generated using TypeDoc
A thread worker used by a poolifier
-ThreadPool
.When this worker is inactive for more than the given
-maxInactiveTime
, - it will send a termination request to its main thread.If you use a
-DynamicThreadPool
the extra workers that were created will be terminated, - but the minimum number of workers will be guaranteed.-- author
-
- - since
-
-
-Alessandro Pio Ardizio
-0.0.1
-