AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=b1134c0258f8f3382de1f4fc5cf85afb20a8c81a;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=4ab8a26e71a842599ee5d0c50003bbbb4bd7f466;hpb=d49303bcd1dc86f36030dff08796f869681d4eae;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 4ab8a26e..b1134c02 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier

+AbstractWorker | poolifier

@@ -18,32 +18,32 @@

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
+
Data = unknown

Type of data this worker receives from pool's execution. This can only be serializable data.
-
Response = unknown
+
Response = unknown

Type of response the worker sends back to the main worker. This can only be serializable data.

Hierarchy

AsyncResource +
AsyncResource
- AbstractWorker
  - ClusterWorker
  - ThreadWorker

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

@@ -51,334 +51,285 @@

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

aliveInterval? +isMain +lastTaskTimestamp +mainWorker +opts +taskFunctions

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>

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: undefined | null | MainWorker

Reference to main worker.
-
opts: WorkerOptions = ...
+
opts: WorkerOptions = ...

Options for the worker.

Returns AbstractWorker<MainWorker, Data, Response>

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

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

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

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

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

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

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

`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(): 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/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315

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

bind

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

Parameters

-
fn: Func
+
fn: Func

The function to bind to the current AsyncResource.

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

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

`Protected` checkAlive

checkAlive(): void

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

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

`Private` checkFunctionInput

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

`Private` checkTaskFunctions

checkTaskFunctions(taskFunctions): void
-
Checks if the fn parameter is passed to the constructor.
-
-
-
Parameters
-
- -
  fn: ((data: Data) => Response)
  -
  The function that should be defined.
  +
  Checks if the taskFunctions parameter is passed to the constructor.
  
  -
  - -
    -
    (data: Data): Response
    -
    
    Parameters
    
    -
    data: Data
    -
    Returns Response
+
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:98

`Private` checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void

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

Returns void

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

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 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>
+
Returns AbstractWorker<MainWorker, Data, Response>
A reference to asyncResource.
+
Inherited from AsyncResource.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.2.5/node_modules/@types/node/async_hooks.d.ts:302

`Protected` getMainWorker

getMainWorker(): MainWorker

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

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

`Protected` handleError

handleError(e: string | Error): string
Defined in src/worker/abstract-worker.ts:162

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<Data, Response>
-
Handles an error and convert it to a string so it can be sent back to the main worker.
- -
Returns
Message of the error.
+
Gets the task function in the given scope.
Parameters
- -
  e: string | Error
  -
  The error raised by the worker.
  +
  Optional name: string
  +
  Name of the function that will be returned.
-
Returns string
+
Returns WorkerFunction<Data, Response>
- Defined in src/worker/abstract-worker.ts:161

`Protected` messageListener

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

`Protected` handleError

handleError(e): string
-
Worker message listener.
-
-
-
Parameters
-
- -
  message: MessageValue<Data, MainWorker>
  -
  Message received.
  -
- -
  fn: ((data: Data) => Response)
  -
  Function processed by the worker when the pool's execution function is invoked.
  +
  Handles an error and convert it to a string so it can be sent back to the main worker.
  
  -
  - -
    -
    (data: Data): Response
    -
    
    Parameters
    
    -
    data: Data
    -
    Returns Response
-
Returns void
+
e: string | Error
+
The error raised by the worker.
+

Returns string

Message of the error.

`Protected` run

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

`Protected` messageListener

messageListener(message): void
-
Runs the given function synchronously.
-
-
-
Parameters
-
- -
  fn: ((data?: Data) => Response)
  -
  Function that will be executed.
  +
  Worker message listener.
  
  -
  - -
    -
    (data?: Data): Response
    -
    
    Parameters
    
    -
    Optional data: Data
    -
    Returns Response
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  +
  message: MessageValue<Data, MainWorker>
  +
  Message received.
Returns void
- Defined in src/worker/abstract-worker.ts:171

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

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), message: MessageValue<Data, unknown>): void

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

@@ -386,31 +337,20 @@ 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>
- -
  message: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, Worker | MessagePort>
  
  Input data for the given function.
Returns void
- Defined in src/worker/abstract-worker.ts:198

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

runInAsyncScope

runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): 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 @@ -419,49 +359,70 @@ 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, Worker | MessagePort>
  +
  Input data for the given function.
  +
+
Returns void
+
- Defined in src/worker/abstract-worker.ts:204

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void

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

@@ -469,59 +430,56 @@ then restore the original execution context.

Parameters
- -
  message: MessageValue<Response, unknown>
  +
  message: MessageValue<Response, Worker | MessagePort>
  
  The response message.
Returns void
- Defined in src/worker/abstract-worker.ts:141

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

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 AsyncResource.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.2.5/node_modules/@types/node/async_hooks.d.ts:311

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: 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
-
+
ThisArg

Parameters

-
fn: Func
+
fn: Func

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

An optional name to associate with the underlying AsyncResource.
-
Optional thisArg: ThisArg