X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FClusterWorker.html;h=81e99470e3b4c9b76cf389394e10d6075e02d745;hb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;hp=f89d2098a8fc4e71989f755da493a2561abe9b45;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index f89d2098..81e99470 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.
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,27 +59,37 @@ but the minimum number of workers will be guaranteed.
Properties
-Accessors
+Methods
-Parameters
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
execution
function is invoked.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
Readonly
isProtected
last Worker
-Protected
mainReference to main worker.
-Protected
Readonly
opts
-Protected
statisticsPerformance statistics computation.
+Performance statistics computation requirements.
Functions
-Protected
taskTask function(s) processed by the worker when the pool's
execution
function is invoked.Accessors
+
+Protected
id+- get id(): number
+-
+
+
Worker id.
+Returns number
+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.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
@@ -194,7 +242,7 @@ but the minimum number of workers will be guaranteed.
bind
@@ -221,19 +269,7 @@ but the minimum number of workers will be guaranteed.
Alive
-Protected
check-- check
Alive(): void
--
-
-
Checks if the worker should be terminated, because its living too long.
-Returns void
-emit Destroy
@@ -249,7 +285,7 @@ never be called.
Protected
get@@ -262,10 +298,10 @@ never be called.
Error
-Protected
handle+- handle
Error(e): string
-
-
Handles an error and convert it to a string so it can be sent back to the main worker.
@@ -278,12 +314,88 @@ never be called.The error raised by the worker.
Returns string
Message of the error.
+Returns string
The error message.
+ + Kill Message
+Protected
handle+- handle
Kill Message(message): void
+-
+
+
+
+
Handles a kill message sent by the main worker.
+Parameters
++-
+
+
message: MessageValue<Data, unknown>
+The kill message.
+Returns void
+ Ready Message
+Protected
handle+- handle
Ready Message(message): void
+-
+
+
+
+
Handles the ready message sent by the main worker.
+Parameters
++-
+
+
message: MessageValue<Data, unknown>
+The ready message.
+Returns void
+has Task Function
++- has
Task Function(name): boolean
+-
+
+
+
+
+
Checks if the worker has a task function with the given name.
+Parameters
++-
+
+
name: string
+The name of the task function to check.
+Returns boolean
Whether the worker has a task function with the given name or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+name
parameter is not a string.list Task Functions
++- list
Task Functions(): string[]
+-
+
+
Lists the names of the worker's task functions.
+Returns string[]
The names of the worker's task functions.
Protected
message@@ -295,40 +407,89 @@ never be called.-
-
Parameters
message: MessageValue<Data, Worker>
-Message received.
+message: MessageValue<Data, unknown>
+The received message.
Returns void
remove Task Function
++- remove
Task Function(name): boolean
+-
+
+
+
+
+
Removes a task function from the worker.
+Parameters
++-
+
+
name: string
+The name of the task function to remove.
+Returns boolean
Whether the task function existed and was removed or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +name
parameter is not a 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-error If the
+name
parameter is the task function used as default task function.
+Protected
run+- run(task): void
+-
+
+
+
+
+
Runs the given task.
+Parameters
++-
+
+
task: Task<Data>
+The task to execute.
+Returns void
+Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Protected
run-- run
Async(fn, message): void
+- run
Async(fn, task): void
-
-
-
-
-
-
+- Defined in src/worker/abstract-worker.ts:451
+- Defined in node_modules/.pnpm/@types+node@20.4.9/node_modules/@types/node/async_hooks.d.ts:294
Sync
\ No newline at end of file
Runs the given function asynchronously.
+Runs the given task function asynchronously.
Parameters
fn: WorkerAsyncFunction<Data, Response>
-Function that will be executed.
+fn: TaskAsyncFunction<Data, Response>
+Task function that will be executed.
message: MessageValue<Data, Worker | MessagePort>
-Input data for the given function.
+task: Task<Data>
+Input data for the task function.
Returns void
run In Async Scope
@@ -383,44 +544,44 @@ then restore the original execution context.
Protected
run-- run
Sync(fn, message): void
+- run
Sync(fn, task): void
-
-
-
-
-
-
+- Defined in src/worker/abstract-worker.ts:415
To Main Worker
- send
To Main Worker(message): void
-
-
-
-
@@ -428,7 +589,34 @@ then restore the original execution context.
+- Defined in src/worker/cluster-worker.ts:58
+
+
+- Defined in node_modules/.pnpm/@types+node@20.4.9/node_modules/@types/node/async_hooks.d.ts:311
+ - Defined in node_modules/.pnpm/@types+node@20.4.9/node_modules/@types/node/async_hooks.d.ts:277
@@ -496,28 +684,35 @@ then restore the original execution context.
- constructor
-- alive
Interval
+- active
Interval
- is
Main
- last
Task Timestamp
-- main
Worker
- opts
- statistics
- task
Functions
+- id
+- add
Task Function
- async
Id
- bind
-- check
Alive
- emit
Destroy
- get
Main Worker
-- handle
Error
+- handle
Error
+- handle
Kill Message
+- handle
Ready Message
+- has
Task Function
+- list
Task Functions
- message
Listener
+- remove
Task Function
+- run
- run
Async
- run
In Async Scope
- run
Sync
- send
To Main Worker
+- set
Default Task Function
- trigger
Async Id
- bind
-
+- Worker
Types
+- available
Parallelism
Runs the given function synchronously.
+Runs the given task function synchronously.
Parameters
fn: WorkerSyncFunction<Data, Response>
-Function that will be executed.
+fn: TaskSyncFunction<Data, Response>
+Task function that will be executed.
message: MessageValue<Data, Worker | MessagePort>
-Input data for the given function.
+task: Task<Data>
+Input data for the task function.
Returns void
Protected
sendSends a message to the main worker.
+Sends a message to main worker.
Parameters
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The response message.
set Default Task Function
++- set
Default Task Function(name): boolean
+-
+
+
+
+
+
Sets the default task function to use in the worker.
+Parameters
++-
+
+
name: string
+The name of the task function to use as default task function.
+Returns boolean
Whether the default task function was set or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +name
parameter is not a 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-error If the
+name
parameter is a non-existing task function.trigger Async Id
@@ -439,7 +627,7 @@ then restore the original execution context.
Static
bind@@ -475,7 +663,7 @@ then restore the original execution context.
Generated using TypeDoc