ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=a6a200fbd4a044f43ec626a73f7740e148951e2d;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=78aa3c24c4800fdab07db1fb45c39f61ece0f43a;hpb=d5d8ef5b0645ff2e43010f981a768c48cd559854;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 78aa3c24..a6a200fb 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier

+ThreadWorker | poolifier - v2.6.19

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

ThreadWorker

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

@@ -59,27 +59,38 @@ but the minimum number of workers will be guaranteed.

Properties

aliveInterval? +

activeInterval? isMain lastTaskTimestamp -mainWorker opts +port statistics taskFunctions

Accessors

id +

@@ -116,18 +127,18 @@ but the minimum number of workers will be guaranteed.

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

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

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

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -163,7 +165,15 @@ but the minimum number of workers will be guaranteed.

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

`Private` port

port: MessagePort

Message port used to communicate with the main thread.

`Protected` statistics

statistics: WorkerStatistics

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

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

`Protected` taskFunctions

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

@@ -181,9 +191,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:77

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:186

asyncId

Defined in node_modules/.pnpm/@types+node@20.4.2/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:192

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

emitDestroy

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

`Protected` getMainWorker

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

`Protected` handleError

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

The error raised by the worker.

Returns string

Message of the error.

Returns string

The error message.

`Protected` handleKillMessage

handleKillMessage(message): void
+
Handles a kill message sent by the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The kill message.
  +
  +
+
Returns void
+
+
Overrides AbstractWorker.handleKillMessage
+
- Defined in src/worker/thread-worker.ts:70

`Protected` handleReadyMessage

handleReadyMessage(message): void
+
Handles the ready message sent by the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The ready message.
  +
  +
+
Returns void
+
+
Overrides AbstractWorker.handleReadyMessage
+
- Defined in src/worker/thread-worker.ts:56

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:168

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of the worker's task functions.
+
+
Returns string[]
The names of the worker's task functions.
-
Inherited from AbstractWorker.handleError
+
Inherited from AbstractWorker.listTaskFunctions
- Defined in src/worker/abstract-worker.ts:207

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

`Protected` messageListener

Parameters

-
message: MessageValue<Data, Data>
-
Message received.
+
message: MessageValue<Data, unknown>
+
The received message.

Returns void

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

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:225

`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:400

`Protected` runAsync

runAsync(fn, message): void
runAsync(fn, task): void
-
Runs the given function asynchronously.
+
Runs the given task function asynchronously.
Parameters
- fn: WorkerAsyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, unknown>
  -
  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:250

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

runInAsyncScope

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

`Protected` runSync

runSync(fn, message): void
runSync(fn, task): void
-
Runs the given function synchronously.
+
Runs the given task function synchronously.
Parameters
- fn: WorkerSyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, unknown>
  -
  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:217

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

`Protected` sendToMainWorker

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

setDefaultTaskFunction

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

triggerAsyncId

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

`Static` bind

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

task: Task<Data>

task: Task<Data>