ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=7d135a5d4c62b1ec643daa1745670febf4cb1ebd;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=4b9f97027359c76adcd0f97879a17d9d3ec9693d;hpb=2946f23da560702e3f3631887e1eeb88777bd47d;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 4b9f9702..7d135a5d 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier

+ThreadWorker | poolifier - v2.6.40

@@ -21,22 +21,25 @@ it will send a termination request to its main thread.

If you use a DynamicThreadPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.

Author

Alessandro Pio Ardizio

Author

Alessandro Pio Ardizio

- -

Since

0.0.1

Since

0.0.1

Type Parameters

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.

Hierarchy

ThreadWorker

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

@@ -52,44 +55,58 @@ but the minimum number of workers will be guaranteed.

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

activeInterval? +isMain +lastTaskTimestamp +opts +port +statistics +taskFunctions +

Accessors

Constructors

constructor

new ThreadWorker<Data, Response>(fn, opts?): ThreadWorker<Data, Response>
new ThreadWorker<Data, Response>(taskFunctions, opts?): ThreadWorker<Data, Response>
Constructs a new poolifier thread worker.

-
+
Type Parameters
-

Returns ThreadWorker<Data, Response>

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

`Protected` mainWorker

mainWorker: undefined | null | MessagePort

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

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

`Private` port

port: MessagePort

Message port used to communicate with the main worker.

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

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

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

Accessors

`Protected` id

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

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

asyncId

asyncId(): number
asyncId(): number
-
-
Returns
The unique asyncId assigned to the resource.
-
-
Returns number
+
Returns number
The unique asyncId assigned to the resource.
+ +
Inherited from AbstractWorker.asyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315

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

bind

bind<Func>(fn): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
bind<Func>(fn): Func
Binds the given function to execute to this AsyncResource's scope.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
- -
Since
v14.8.0, v12.19.0

-
+
Type Parameters
-
@@ -188,58 +268,50 @@ the AsyncResource to which the function is bound.

fn: Func

The function to bind to the current AsyncResource.

Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}

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

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

emitDestroy

emitDestroy(): ThreadWorker<Data, Response>
emitDestroy(): ThreadWorker<Data, Response>
Call all destroy hooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then the destroy hooks will never be called.
- -
Returns
A reference to asyncResource.

-
Returns ThreadWorker<Data, Response>
+
Returns ThreadWorker<Data, Response>
A reference to asyncResource.
+ +
Inherited from AbstractWorker.emitDestroy
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311

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

`Protected` getMainWorker

getMainWorker(): MessagePort
getMainWorker(): MessagePort
Returns the main worker.
- -
Returns
Reference to the main worker.

-
Returns MessagePort
+
Returns MessagePort
Reference to the main worker.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:139

`Protected` handleError

handleError(e): string
Defined in src/worker/abstract-worker.ts:434

`Protected` handleError

handleError(e): string
Handles an error and convert it to a string so it can be sent back to the main worker.
- -
Returns
Message of the error.

Parameters
@@ -248,14 +320,89 @@ never be called.

e: string | Error

The error raised by the worker.

Returns string

`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/abstract-worker.ts:171

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

`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

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 or an empty string.
+
+
Inherited from AbstractWorker.hasTaskFunction
+
- Defined in src/worker/abstract-worker.ts:177

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

`Protected` messageListener

messageListener(message, fn): void
messageListener(message): void
Worker message listener.

@@ -263,76 +410,97 @@ never be called.

Parameters
- -
  message: MessageValue<Data, MessagePort>
  -
  Message received.
  -
- -
  fn: WorkerFunction<Data, Response>
  -
  Function processed by the worker when the pool's execution function is invoked.
  +
  message: MessageValue<Data, unknown>
  +
  The received message.
-
Returns void
+
Returns void
+
Inherited from AbstractWorker.messageListener
- Defined in src/worker/abstract-worker.ts:89

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

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

`Protected` run

run(fn, message): void
run(task): void
-
Runs the given function synchronously.
+
Runs the given task.
Parameters
- -
  fn: WorkerSyncFunction<Data, Response>
  -
  Function that will be executed.
  -
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  The task to execute.
-
Returns void
+
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:181

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

`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.
  +
  fn: TaskAsyncFunction<Data, Response>
  +
  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
+
Returns void
+
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:208

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

runInAsyncScope

runInAsyncScope<This, Result>(fn, thisArg?, ...args): Result
runInAsyncScope<This, Result>(fn, thisArg?, ...args): Result
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.
- -
Since
v9.6.0

-
+
Type Parameters
-
Returns Result

`Optional` thisArg: This

The receiver to be used for the function call.

+Optional

`Rest` ...args: any[]

Optional arguments to pass to the function.

Returns Result

+Rest +

Returns Result

Since

v9.6.0

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

`Protected` runSync

runSync(fn, task): void
+
Runs the given task function synchronously.
+
+
+
Parameters
+
- +
  fn: TaskSyncFunction<Data, Response>
  +
  Task function that will be executed.
  +
- +
  task: Task<Data>
  +
  Input data for the task function.
  +
+
Returns void
+
+
Inherited from AbstractWorker.runSync
+
- Defined in src/worker/abstract-worker.ts:504

`Protected` sendTaskFunctionsListToMainWorker

sendTaskFunctionsListToMainWorker(): void
+
Sends the list of task function names to the main worker.
+
+
Returns void
+
+
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+
- Defined in src/worker/abstract-worker.ts:453

`Protected` sendToMainWorker

sendToMainWorker(message): void
sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.

Parameters
@@ -383,36 +589,58 @@ then restore the original execution context.

message: MessageValue<Response, unknown>

The response message.

Returns void

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

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 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-error If the name parameter is a non-existing task function.
+
+
Inherited from AbstractWorker.setDefaultTaskFunction
+
- Defined in src/worker/abstract-worker.ts:285

triggerAsyncId

triggerAsyncId(): number
triggerAsyncId(): number
-
-
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
-
-
Returns number
+
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
+ +
Inherited from AbstractWorker.triggerAsyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

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

`Static` bind

bind<Func, ThisArg>(fn, type?, thisArg?): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
bind<Func, ThisArg>(fn, type?, thisArg?): Func
Binds the given function to the current execution context.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
- -
Since
v14.8.0, v12.19.0

-
+
Type Parameters
-
+
Returns Func
+
+
Since
v14.8.0, v12.19.0
+
Inherited from AbstractWorker.bind
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273