ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=bd7cbabcbb4aeba6822b9c90262425cdc956602c;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=dae2a4a7522e22f27deb657684b4ce28da4de7a7;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index dae2a4a7..bd7cbabc 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier

+ThreadWorker | poolifier - v2.6.12

@@ -32,12 +32,12 @@ but the minimum number of workers will be guaranteed.

Data = unknown
-
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 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.

@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

ThreadWorker

Defined in src/worker/thread-worker.ts:26

@@ -64,22 +64,32 @@ but the minimum number of workers will be guaranteed.

lastTaskTimestamp mainWorker opts +statistics taskFunctions

Accessors

id +

@@ -115,18 +125,18 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:36

Properties

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Optional` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

Defined in src/worker/abstract-worker.ts:63

`Protected` `Readonly` isMain

isMain: boolean

@@ -135,7 +145,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:75

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -144,16 +154,16 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:55

`Protected` mainWorker

mainWorker: undefined | null | MessagePort

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

Reference to main worker.

Defined in src/worker/abstract-worker.ts:79

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -162,7 +172,16 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:80

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

taskFunctions: Map<string, WorkerFunction<Data, Response>>

@@ -171,9 +190,56 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:51

Accessors

`Protected` id

get id(): number
+
Worker id.
+
+
Returns number
+
+
Overrides AbstractWorker.id
+
- Defined in src/worker/thread-worker.ts:51

Methods

addTaskFunction

addTaskFunction(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: WorkerFunction<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.
+
+
Inherited from AbstractWorker.addTaskFunction
+
- Defined in src/worker/abstract-worker.ts:172

asyncId

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:306

bind

`Protected` checkAlive

checkAlive(): void
-
Checks if the worker should be terminated, because its living too long.
-
-
Returns void
-
-
Inherited from AbstractWorker.checkAlive
-
- Defined in src/worker/abstract-worker.ts:182

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:283

emitDestroy

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:302

`Protected` getMainWorker

Defined in src/worker/abstract-worker.ts:336

`Protected` handleError

handleError(e): string
Handles an error and convert it to a string so it can be sent back to the main worker.
@@ -268,12 +322,35 @@ never be called.

The error raised by the worker.

Returns string

Message of the error.

Returns string

The error message.

hasTaskFunction

hasTaskFunction(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.
+
+
Inherited from AbstractWorker.hasTaskFunction
- Defined in src/worker/abstract-worker.ts:197

Defined in src/worker/abstract-worker.ts:154

`Protected` messageListener

Parameters

-
message: MessageValue<Data, MessagePort>
+
message: MessageValue<Data, Data>

Message received.

Defined in src/worker/abstract-worker.ts:271

removeTaskFunction

removeTaskFunction(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.
+
+
Inherited from AbstractWorker.removeTaskFunction
+
- Defined in src/worker/abstract-worker.ts:210

`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.
+
+
Inherited from AbstractWorker.run
+
- Defined in src/worker/abstract-worker.ts:368

`Protected` runAsync

runAsync(fn, message): void
runAsync(fn, task): void
Runs the given function asynchronously.

@@ -306,19 +432,19 @@ never be called.
- fn: WorkerAsyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  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
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:240

Defined in src/worker/abstract-worker.ts:421

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:294

`Protected` runSync

runSync(fn, message): void
runSync(fn, task): void
Runs the given function synchronously.

@@ -386,19 +512,19 @@ then restore the original execution context.
- fn: WorkerSyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  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
Inherited from AbstractWorker.runSync
- Defined in src/worker/abstract-worker.ts:207

Defined in src/worker/abstract-worker.ts:383

`Protected` sendToMainWorker

Parameters

-
message: MessageValue<Response, Worker | MessagePort>
+
message: MessageValue<Response, unknown>

The response message.

Defined in src/worker/thread-worker.ts:56

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
+
Sets the default task function to use when no task function name is specified.
+
+
+
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.
+
+
Inherited from AbstractWorker.setDefaultTaskFunction
+
- Defined in src/worker/abstract-worker.ts:238

triggerAsyncId

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:311

`Protected` workerReady

workerReady(): void
+
Notifies the main worker that this worker is ready to process tasks.
+
+
Returns void
+
+
Inherited from AbstractWorker.workerReady
+
- Defined in src/worker/abstract-worker.ts:296

`Static` bind

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:277

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file