ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=a425fbf372a4d2c9a8a4beaaad647aa440c335c1;hb=8cc4ea811611b8ad77c7b0379911afe497f2e7e4;hp=284da061dc2bef6d7dce4bea255fb79ab045920d;hpb=79f98bd9040049eec047b50d2cbd0878fdc9e6f1;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 284da061..a425fbf3 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v2.6.15

+ThreadWorker | poolifier - v2.6.28

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

ThreadWorker

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

@@ -62,8 +62,8 @@ but the minimum number of workers will be guaranteed.

activeInterval? isMain lastTaskTimestamp -mainWorker opts +port statistics taskFunctions

@@ -79,14 +79,17 @@ but the minimum number of workers will be guaranteed.

emitDestroy getMainWorker handleError +handleKillMessage +handleReadyMessage hasTaskFunction +listTaskFunctions messageListener removeTaskFunction run runAsync runInAsyncScope runSync -sendReadyResponse +sendTaskFunctionsListToMainWorker sendToMainWorker setDefaultTaskFunction triggerAsyncId @@ -112,7 +115,7 @@ but the minimum number of workers will be guaranteed.

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.

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

Properties

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

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

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -154,16 +157,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 = ...

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

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

`Private` port

port: MessagePort

Message port used to communicate with the main worker.

`Protected` statistics

statistics: WorkerStatistics

@@ -181,16 +183,16 @@ 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>>

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

Task function(s) processed by the worker when the pool's execution function is invoked.

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

Accessors

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

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

Methods

@@ -224,14 +226,14 @@ If a task function with the same name already exists, it is replaced.

fn: WorkerFunction<Data, Response>

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-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.

@@ -239,7 +241,7 @@ If a task function with the same name already exists, it is replaced.

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

asyncId

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

bind

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

emitDestroy

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

`Protected` getMainWorker

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

`Protected` handleError

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

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

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

hasTaskFunction

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.

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

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

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.listTaskFunctions
+
- Defined in src/worker/abstract-worker.ts:267

`Protected` messageListener

Parameters

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

The received message.

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

removeTaskFunction

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-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.

@@ -397,7 +452,7 @@ never be called.

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

`Protected` run

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

`Protected` runAsync

Parameters

-
fn: WorkerAsyncFunction<Data, Response>
+
fn: TaskAsyncFunction<Data, Response>

Task function that will be executed.

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

runInAsyncScope

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

`Protected` runSync

Parameters

-
fn: WorkerSyncFunction<Data, Response>
+
fn: TaskSyncFunction<Data, Response>

Task function that will be executed.

`Protected` sendReadyResponse

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

`Protected` sendTaskFunctionsListToMainWorker

sendReadyResponse(): void
sendTaskFunctionsListToMainWorker(): void
-
Sends to the main worker the ready response.
+
Sends the list of task function names to the main worker.

Returns void
-
Inherited from AbstractWorker.sendReadyResponse
+
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
- Defined in src/worker/abstract-worker.ts:301

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

`Protected` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.
Parameters
@@ -556,13 +611,13 @@ then restore the original execution context.
Overrides AbstractWorker.sendToMainWorker
- Defined in src/worker/thread-worker.ts:56

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

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
-
Sets the default task function to use when no task function name is specified.
+
Sets the default task function to use in the worker.
Parameters
@@ -575,7 +630,7 @@ then restore the original execution context.

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-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.
@@ -583,7 +638,7 @@ then restore the original execution context.
Inherited from AbstractWorker.setDefaultTaskFunction
- Defined in src/worker/abstract-worker.ts:243

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

triggerAsyncId

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

`Static` bind

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