X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=c544fca00d13c053a2729753e25234b188106419;hb=a6b5c73ccccb3ef0ccc24ad462182e3cacee77b4;hp=98e014b8986bdd267c3f3c5f46993d4baeb1937a;hpb=4703c53b33791724a31462d7c6dabd43b0385f7c;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 98e014b8..c544fca0 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier

+AbstractWorker | poolifier - v2.6.9

@@ -17,22 +17,26 @@

Class AbstractWorker<MainWorker, Data, Response>`Abstract`

Base class that implements some shared logic for all poolifier workers.

Type Parameters

MainWorker extends Worker | MessagePort

Type of main worker.
-

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 worker. This can only be serializable data.
-

Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

Hierarchy

ClusterWorker
ThreadWorker

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

@@ -51,40 +55,49 @@

Constructors

constructor

new AbstractWorker<MainWorker, Data, Response>(type, isMain, fn, mainWorker, opts?): AbstractWorker<MainWorker, Data, Response>
new AbstractWorker<MainWorker, Data, Response>(type, isMain, taskFunctions, mainWorker, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier worker.

@@ -103,87 +116,126 @@
type: string

The type of async event.
-

isMain: boolean

Whether this is the main worker or not.
-

-
fn: WorkerFunction<Data, Response>
-
Function processed by the worker when the pool's execution function is invoked.
-

taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>

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

-
mainWorker: undefined | null | MainWorker
+
mainWorker: MainWorker

Reference to main worker.
-

opts: WorkerOptions = ...

Options for the worker.
-

Returns AbstractWorker<MainWorker, Data, Response>

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

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

`Protected` `Abstract` id

id: number

Worker id.

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

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

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

`Protected` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

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

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

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

Methods

asyncId

asyncId(): number
asyncId(): number
-

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

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

`Private` beginTaskPerformance

beginTaskPerformance(): TaskPerformance
+
Returns TaskPerformance
+
- Defined in src/worker/abstract-worker.ts:323

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
@@ -196,42 +248,57 @@ 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
Defined in node_modules/.pnpm/@types+node@20.4.0/node_modules/@types/node/async_hooks.d.ts:283

`Private` checkAlive

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

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

`Private` checkStatistics

checkStatistics(): void
Returns void
- Defined in src/worker/abstract-worker.ts:156

`Private` checkFunctionInput

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

`Private` checkTaskFunctions

checkFunctionInput(fn): void
checkTaskFunctions(taskFunctions): void
-
Checks if the fn parameter is passed to the constructor.
+
Checks if the taskFunctions parameter is passed to the constructor.
Parameters
- -
  fn: WorkerFunction<Data, Response>
  -
  The function that should be defined.
  -
-
Returns void
+
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+
The task function(s) parameter that should be checked.
+
+

Returns void

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

`Private` checkWorkerOptions

checkWorkerOptions(opts): void
checkWorkerOptions(opts): void
Parameters
@@ -240,11 +307,11 @@ the AsyncResource to which the function is bound.

opts: WorkerOptions

Returns void

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

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>
emitDestroy(): AbstractWorker<MainWorker, 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 @@ -252,25 +319,59 @@ the resource is left to be collected by the GC then the destroy hoo never be called.

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

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

`Private` endTaskPerformance

endTaskPerformance(taskPerformance): TaskPerformance
+
+
Parameters
+
- +
  taskPerformance: TaskPerformance
+
Returns TaskPerformance
+
- Defined in src/worker/abstract-worker.ts:331

`Protected` getMainWorker

getMainWorker(): MainWorker
getMainWorker(): MainWorker
Returns the main worker.

Returns MainWorker
Reference to the main worker.
-
+ +
+
- Defined in src/worker/abstract-worker.ts:205

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<Data, Response>
+
Gets the task function in the given scope.
+
+
+
Parameters
+
- +
  Optional name: string
  +
  Name of the function that will be returned.
  +
  +
+
Returns WorkerFunction<Data, Response>
+
- Defined in src/worker/abstract-worker.ts:139

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

`Protected` handleError

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

@@ -280,15 +381,17 @@ never be called.
e: string | Error

The error raised by the worker.
-

Returns string

Message of the error.

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

`Protected` messageListener

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

@@ -296,41 +399,18 @@ never be called.

Parameters
- -
  message: MessageValue<Data, MainWorker>
  +
  message: MessageValue<Data, Data>
  
  Message received.
  -
- -
  fn: WorkerFunction<Data, Response>
  -
  Function processed by the worker when the pool's execution function is invoked.
  -
-
Returns void
-
- Defined in src/worker/abstract-worker.ts:113

`Protected` run

run(fn, message): void
-
Runs the given function synchronously.

-
-
Parameters
-
- -
  fn: WorkerSyncFunction<Data, Response>
  -
  Function that will be executed.
  -
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
-
Returns void
+

Returns void

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

`Protected` runAsync

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

@@ -340,25 +420,26 @@ never be called.
fn: WorkerAsyncFunction<Data, Response>

Function that will be executed.
-

message: MessageValue<Data, unknown>

Input data for the given function.
-

Returns void

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

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
@@ -374,6 +455,7 @@ then restore the original execution context.

fn: ((this, ...args) => Result)

The function to call in the execution context of this async resource.

+
- - Optional thisArg: This
    
    The receiver to be used for the function call.
    -
  - Rest ...args: any[]
    
    Optional arguments to pass to the function.
    -
  -
  Returns Result
  + +
+
Returns Result
+
+
Since
v9.6.0
+
Inherited from AsyncResource.runInAsyncScope
- Defined in node_modules/.pnpm/@types+node@18.16.3/node_modules/@types/node/async_hooks.d.ts:303

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

`Protected` runSync

runSync(fn, message): void
+
Runs the given function synchronously.
+
+
+
Parameters
+
- +
  fn: WorkerSyncFunction<Data, Response>
  +
  Function that will be executed.
  +
  +
- +
  message: MessageValue<Data, unknown>
  +
  Input data for the given function.
  +
  +
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:237

`Protected` `Abstract` sendToMainWorker

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

@@ -410,33 +521,53 @@ then restore the original execution context.

Parameters
- -
  message: MessageValue<Response, unknown>
  +
  message: MessageValue<Response, Data>
  
  The response message.
  -
-
Returns void
+ +

Returns void

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

`Private` startCheckAlive

startCheckAlive(): void
+
Starts the worker alive check interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:172

`Private` stopCheckAlive

stopCheckAlive(): void
+
Stops the worker alive check interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:184

triggerAsyncId

triggerAsyncId(): number
triggerAsyncId(): number
-

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

Defined in node_modules/.pnpm/@types+node@20.4.0/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
@@ -451,22 +582,27 @@ the AsyncResource to which the function is bound.

fn: Func

The function to bind to the current execution context.
-
+ +
Optional type: string

An optional name to associate with the underlying AsyncResource.
-