AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractWorker.html;h=fe134d40e6321a910816c6ed24aabc2cbe49f7c7;hb=ab80dc4621654ddd6f327ffec8db9a425e56e6d1;hp=88a908c324ef4646e4e540fe10094abc103cee58;hpb=f1583b4edd427f8c3f2b4ddc652d2e102390b08e;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 88a908c3..fe134d40 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,15 @@ -AbstractWorker | poolifier

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

Type Parameters

-
MainWorker extends Worker | MessagePort
+
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.

Data = unknown

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.

Response = unknown

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

Hierarchy

AsyncResource +
AsyncResource
- AbstractWorker
  - ClusterWorker
  - ThreadWorker

@@ -49,318 +55,351 @@

Constructors

constructor

new AbstractWorker<MainWorker, Data, Response>(type: string, isMain: boolean, fn: ((data: Data) => Response), mainWorker: undefined | null | MainWorker, opts?: WorkerOptions): AbstractWorker<MainWorker, Data, Response>

constructor

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

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
type: string
+
type: string

The type of async event.
-

-
isMain: boolean
+
isMain: boolean

Whether this is the main worker or not.
-
-
fn: ((data: Data) => Response)
-
Function processed by the worker when the pool's execution function is invoked.

-
- -
  - (data: Data): Response
  - -
    -
    Parameters
    -
    - -
      data: Data
    -
    Returns Response

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>

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler Id of the aliveInterval worker alive check.

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

`Protected` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

`Readonly` opts

opts: WorkerOptions

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

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

`Protected` taskFunctions

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

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

Methods

asyncId

asyncId(): number

asyncId

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

bind

bind<Func>(fn: Func): Func & { asyncResource: AsyncResource }
Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:306

`Private` beginTaskPerformance

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

bind

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
-
+
Func extends ((...args) => any)

Parameters

-
fn: Func
+
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.3.2/node_modules/@types/node/async_hooks.d.ts:283

`Protected` checkAlive

checkAlive(): void
-
Check to see if the worker should be terminated, because its living too long.
+
Checks if the worker should be terminated, because its living too long.

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

`Private` checkStatistics

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

`Private` checkFunctionInput

checkFunctionInput(fn: ((data: Data) => Response)): void
Defined in src/worker/abstract-worker.ts:318

`Private` checkTaskFunctions

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: ((data: Data) => Response)
  -
  The function that should be defined.
  +
  taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
  +
  The task function(s) parameter that should be checked.
  
  -
  -
  -
  -
  (data: Data): Response
  -
  -
  -
  Parameters
  -
  -
  -
  data: Data
  -
  Returns Response
-
Returns void
+

Returns void

`Private` checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void
Defined in src/worker/abstract-worker.ts:109

`Private` checkWorkerOptions

checkWorkerOptions(opts): void
Parameters
- -
  opts: WorkerOptions
+
opts: WorkerOptions

Returns void

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>
Defined in src/worker/abstract-worker.ts:97

emitDestroy

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 the resource is left to be collected by the GC then the destroy hooks will never be called.
- -
Returns
A reference to asyncResource.

-
Returns AbstractWorker<MainWorker, Data, Response>
-
Inherited from AsyncResource.emitDestroy
-
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:311

`Protected` getMainWorker

getMainWorker(): MainWorker
-
Returns the main worker.
+
Returns AbstractWorker<MainWorker, Data, Response>
A reference to asyncResource.
-
Returns
Reference to the main worker.
-
-
Returns MainWorker
+
+
Inherited from AsyncResource.emitDestroy
- Defined in src/worker/abstract-worker.ts:127

`Protected` handleError

handleError(e: string | Error): string
Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:302

`Private` endTaskPerformance

endTaskPerformance(taskPerformance): TaskPerformance
-
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
- -
  e: string | Error
  -
  The error raised by the worker.
  -
-
Returns string
+
taskPerformance: TaskPerformance

Returns TaskPerformance

`Protected` messageListener

messageListener(value: MessageValue<Data, MainWorker>, fn: ((data: Data) => Response)): void
Defined in src/worker/abstract-worker.ts:303

`Protected` getMainWorker

getMainWorker(): MainWorker
-
-
Parameters
-
- -
  value: MessageValue<Data, MainWorker>
- -
  fn: ((data: Data) => Response)
  -
  - -
    - (data: Data): Response

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<Data, Response>
+
Gets the task function in the given scope.
+
Parameters
- -
  data: Data
-
Returns Response

Returns void

`Protected` run

run(fn: ((data?: Data) => Response), value: MessageValue<Data, unknown>): void
Defined in src/worker/abstract-worker.ts:286

`Protected` handleError

handleError(e): string
-
Runs the given function synchronously.
+
Handles an error and convert it to a string so it can be sent back to the main worker.
Parameters
- -
  fn: ((data?: Data) => Response)
  -
  Function that will be executed.
  +
  e: string | Error
  +
  The error raised by the worker.
  
  -
  -
  -
  -
  (data?: Data): Response
  +
  +
  Returns string
  Message of the error.
  + +
  +
  +
  Defined in src/worker/abstract-worker.ts:207

`Protected` messageListener

messageListener(message): void
+
Worker message listener.
+
Parameters
- -
  Optional data: Data
-
Returns Response

value: MessageValue<Data, unknown>

Input data for the given function.

Returns void

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), value: MessageValue<Data, unknown>): void
Defined in src/worker/abstract-worker.ts:149

`Protected` runAsync

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

@@ -368,82 +407,102 @@ never be called.

Parameters
- -
  fn: ((data?: Data) => Promise<Response>)
  +
  fn: WorkerAsyncFunction<Data, Response>
  
  Function that will be executed.
  
  -
  - -
    - (data?: Data): Promise<Response>
    - -
      -
      Parameters
      -
      +
      
      -
      Optional data: Data
      -
      Returns Promise<Response>
- -
  value: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, unknown>
  
  Input data for the given function.
  -
-
Returns void
+ +

Returns void

runInAsyncScope

runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): Result
Defined in src/worker/abstract-worker.ts:250

runInAsyncScope

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
-
+
Result

Parameters

-
fn: ((this: This, ...args: any[]) => Result)
+
fn: ((this, ...args) => Result)

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

+
- -
  - (this: This, ...args: any[]): Result

Returns Result

`Optional` thisArg: This

The receiver to be used for the function call.

+ +

`Rest` ...args: any[]

Optional arguments to pass to the function.

Returns Result

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

`Protected` `Abstract` sendToMainWorker

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

@@ -451,63 +510,66 @@ then restore the original execution context.

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

Returns void

triggerAsyncId

triggerAsyncId(): number
Defined in src/worker/abstract-worker.ts:185

triggerAsyncId

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 AsyncResource.triggerAsyncId
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:320

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & { asyncResource: AsyncResource }
Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:311

`Static` bind

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
-
+
ThisArg

Parameters

-
fn: Func
+
fn: Func

The function to bind to the current execution context.
-

`Optional` type: string

An optional name to associate with the underlying AsyncResource.

+ +

`Optional` thisArg: ThisArg

Returns Func & { asyncResource: AsyncResource }

+ + - - + +

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

MainWorker extends Worker | MessagePort

MainWorker extends Worker | MessagePort

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

constructor

Type Parameters

MainWorker extends Worker | MessagePort

MainWorker extends Worker | MessagePort

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Parameters

type: string

type: string

isMain: boolean

isMain: boolean

fn: ((data: Data) => Response)

Parameters

data: Data

Returns Response

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

mainWorker: undefined | null | MainWorker

mainWorker: MainWorker

opts: WorkerOptions = ...

opts: WorkerOptions = ...

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional Readonly aliveInterval

Protected lastTaskTimestamp

Protected mainWorker

Protected Readonly mainWorker

Readonly opts

Protected Readonly opts

Protected statistics

Protected taskFunctions

Methods

asyncId

asyncId

Returns

Returns number

bind

Private beginTaskPerformance

Returns TaskPerformance

bind

Since

Type Parameters

Func extends ((...args: any[]) => any)

Func extends ((...args) => any)

Parameters

fn: Func

fn: Func

Returns Func & { asyncResource: AsyncResource }

Protected checkAlive

Protected checkAlive

Returns void

Private checkStatistics

Returns void

Private checkFunctionInput

Private checkTaskFunctions

Parameters

fn: ((data: Data) => Response)

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

Parameters

data: Data

Returns Response

Returns void

Returns void

Private checkWorkerOptions

Private checkWorkerOptions

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

`Protected` `Optional` `Readonly` aliveInterval

`Protected` lastTaskTimestamp

`Protected` mainWorker

`Protected` `Readonly` mainWorker

`Readonly` opts

`Protected` `Readonly` opts

`Protected` statistics

`Protected` taskFunctions

`Private` beginTaskPerformance

`Protected` checkAlive

`Protected` checkAlive

`Private` checkStatistics

`Private` checkFunctionInput

`Private` checkTaskFunctions

`Private` checkWorkerOptions

`Private` checkWorkerOptions

`Protected` getMainWorker

`Protected` handleError

`Private` endTaskPerformance

`Protected` messageListener

`Protected` getMainWorker

`Private` getTaskFunction

`Protected` run

`Protected` handleError

`Protected` messageListener

`Optional` data: Data

`Protected` runAsync

`Protected` runAsync

`Optional` data: Data