X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=b29b5f35df304a9632c2dca952421cdba5179c09;hb=019581cc38fe0b47645d9b2120f325ab37388be2;hp=c4da792dfd210020c6d059c52cf65adc5eb494aa;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c4da792d..b29b5f35 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -
Protected
checkPrivate
checkPrivate
checkCheck if the message worker id is set and matches the worker id.
+The message to check.
+https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
+Private
checkPrivate
checkThe task function(s) parameter that should be checked.
Private
checkPrivate
endProtected
getPrivate
getGets the task function in the given scope.
+Gets the task function with the given name.
Optional
name: stringName of the function that will be returned.
+Name of the task function that will be returned.
Protected
handleThe error raised by the worker.
Message of the error.
+The error message.
Protected
handleHandles a kill message sent by the main worker.
+The kill message.
+Protected
Abstract
handleHandles the ready message sent by the main worker.
+The ready message.
+Checks 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 or an empty string.
Lists the names of the worker's task functions.
+The names of the worker's task functions.
+ +Protected
messageRemoves a task function from the worker.
+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.
Protected
runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Protected
runRuns the given function asynchronously.
+Runs the given task function asynchronously.
Function that will be executed.
+Task function that will be executed.
Inherited from AsyncResource.runInAsyncScope
Protected
runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
+Task function that will be executed.
Protected
sendSends the list of task function names to the main worker.
+Protected
Abstract
sendSends a message to the main worker.
+Sends a message to main worker.
The response message.
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.
Private
startStarts the worker check active interval.
+Private
stopStops the worker check active interval.
+Inherited from AsyncResource.triggerAsyncId
Private
updateStatic
bindInherited from AsyncResource.bind
Generated using TypeDoc
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.
Response = unknown
-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.
@@ -59,30 +59,48 @@
Properties
-Methods
-constructor
-- new
Abstract Worker<MainWorker, Data, Response>(type, isMain, taskFunctions, mainWorker, opts?): AbstractWorker<MainWorker, Data, Response>
+- new
Abstract Worker<MainWorker, Data, Response>(type, isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
-
@@ -98,7 +116,7 @@
-
-
+
-
-
@@ -117,13 +135,13 @@
Constructs a new poolifier worker.
Type Parameters
MainWorker extends Worker | MessagePort
MainWorker extends MessagePort | Worker
Data = unknown
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
-Task function(s) processed by the worker when the pool's
+execution
function is invoked. The first function is the default function.mainWorker: MainWorker
+Reference to main worker.
mainWorker: undefined | null | MainWorker
-Reference to main worker.
+taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
+Task function(s) processed by the worker when the pool's
execution
function is invoked. The first function is the default function.Properties
- Interval
-Protected
Optional
Readonly
aliveHandler id of the
+aliveInterval
worker alive check. Interval
+Protected
Optional
activeHandler id of the
activeInterval
worker activity check.
+Protected
Abstract
idWorker id.
+Protected
Readonly
isProtected
last Worker
-Protected
main Worker
+Private
Readonly
mainReference to main worker.
Protected
Readonly
opts
+Protected
statisticsPerformance statistics computation requirements.
+ Functions
-Protected
taskTask function(s) processed by the worker when the pool's
execution
function is invoked.Methods
+add Task Function
++- add
Task Function(name, fn): boolean
+-
+
+
+
+
+
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+Parameters
++-
+
+
+-
+
+
name: string
+The name of the task function to add.
+fn: TaskFunction<Data, Response>
+The task function to add.
+Returns boolean
Whether the task function was added or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +name
parameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-error If the
+ +name
parameter is the default task function reserved name.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+fn
parameter is not a function.async Id
@@ -198,7 +264,20 @@
Task Performance
+Private
begin+- begin
Task Performance(name?): TaskPerformance
+-
+
+
+
Parameters
++-
+
Optional
name: stringReturns TaskPerformance
bind
@@ -225,18 +304,47 @@