AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=2fe528e337366b26aeb513f8e8db91df4d8e80f0;hb=7b88db4b8420d92d98e93c04492319ea814d0fc5;hp=ebbaf67a5dc7c68a1a13191cf2a13436660944dc;hpb=85c03385d4a5d06c979104ae7e96d68b2301d10a;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index ebbaf67a..2fe528e3 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.11

+AbstractWorker | poolifier - v2.6.14

@@ -47,7 +47,7 @@

ClusterWorker

ThreadWorker

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

@@ -59,7 +59,7 @@

Properties

aliveInterval? +

activeInterval? id isMain lastTaskTimestamp @@ -70,10 +70,11 @@

@@ -143,17 +148,17 @@

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

Properties

`Protected` `Optional` 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` `Abstract` id

id: number

@@ -161,7 +166,7 @@

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -169,7 +174,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -177,7 +182,7 @@

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

`Protected` `Readonly` mainWorker

mainWorker: MainWorker

@@ -185,7 +190,7 @@

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -193,7 +198,7 @@

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

`Protected` statistics

statistics: WorkerStatistics

@@ -201,7 +206,7 @@

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

`Protected` taskFunctions

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

@@ -209,9 +214,41 @@

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

asyncId

`Private` beginTaskPerformance

beginTaskPerformance(): TaskPerformance
beginTaskPerformance(name?): TaskPerformance
+
+
Parameters
+
- +
  Optional name: string
Returns TaskPerformance
- Defined in src/worker/abstract-worker.ts:337

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

bind

Inherited from AsyncResource.bind

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

`Private` checkAlive

`Private` checkActive

checkAlive(): void
checkActive(): void
Checks if the worker should be terminated, because its living too long.

Returns void
- Defined in src/worker/abstract-worker.ts:205

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

`Private` checkStatistics

Returns void
- Defined in src/worker/abstract-worker.ts:360

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

`Private` checkTaskFunctions

Returns void

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

`Private` checkWorkerOptions

opts: WorkerOptions

Returns void

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

emitDestroy

taskPerformance: TaskPerformance

Returns TaskPerformance

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

`Protected` getMainWorker

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

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<Data, Response>
-
Gets the task function in the given scope.
+
Gets the task function with the given name.
Parameters
- Optional name: string
  -
  Name of the function that will be returned.
  +
  Name of the task function that will be returned.
-
Returns WorkerFunction<Data, Response>
-
+
Returns WorkerFunction<Data, Response>
The task function.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+
- Defined in src/worker/abstract-worker.ts:328

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

`Protected` handleError

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

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

`Protected` messageListener

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

Returns void

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

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

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

`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
- Defined in src/worker/abstract-worker.ts:288

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

runInAsyncScope

`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
- Defined in src/worker/abstract-worker.ts:251

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

`Protected` sendReadyResponse

sendReadyResponse(): void
+
Sends to the main worker the ready response.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:301

`Protected` `Abstract` sendToMainWorker

Returns void

`Private` startCheckAlive

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

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

`Private` startCheckActive

startCheckAlive(): void
startCheckActive(): void
-
Starts the worker alive check interval.
+
Starts the worker check active interval.

Returns void
- Defined in src/worker/abstract-worker.ts:186

`Private` stopCheckAlive

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

`Private` stopCheckActive

stopCheckAlive(): void
stopCheckActive(): void
-
Stops the worker alive check interval.
+
Stops the worker check active interval.

Returns void
- Defined in src/worker/abstract-worker.ts:198

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

triggerAsyncId

Inherited from AsyncResource.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
-
-
- Defined in src/worker/abstract-worker.ts:179

`Static` bind

constructor
aliveInterval
activeInterval
id
isMain
lastTaskTimestamp

opts
statistics
taskFunctions
addTaskFunction
asyncId
beginTaskPerformance
bind
checkAlive
checkActive
checkStatistics
checkTaskFunctions
checkWorkerOptions

getMainWorker
getTaskFunction
handleError
hasTaskFunction
messageListener
removeTaskFunction
run
runAsync
runInAsyncScope
runSync
sendReadyResponse
sendToMainWorker
startCheckAlive
stopCheckAlive
setDefaultTaskFunction
startCheckActive
stopCheckActive
triggerAsyncId
workerReady
bind

name: string

fn: WorkerFunction<Data, Response>

Parameters

`Optional` name: string

Returns TaskPerformance

`Optional` name: string

name: string

name: string

task: Task<Data>

fn: WorkerAsyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

Parameters

fn: WorkerSyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

Returns void

name: string

Optional name: string

task: Task<Data>

fn: WorkerSyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

`Optional` name: string