AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=388b91568f37a8f74f3a04cc4cbbcdb3faba48bf;hb=afc34f0c8ee4e44ba301212a5eed3fb01035b1fb;hp=0cc3eca18900fc85ad2f3b0104e151ef4d19ffff;hpb=7e36fa9f0f844e3e60f0c22de3e28665dd8cc9d1;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 0cc3eca1..388b9156 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier

+AbstractWorker | poolifier

@@ -22,28 +22,28 @@

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

@@ -51,40 +51,40 @@

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

aliveInterval? +isMain +lastTaskTimestamp +mainWorker +opts

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, fn, mainWorker, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier worker.

@@ -92,92 +92,81 @@
Type Parameters
- -
  MainWorker extends Worker | MessagePort
- -
  Data = unknown
- -
  Response = unknown

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)
+
fn: WorkerFunction<Data, Response>

Function processed by the worker when the pool's execution function is invoked.
-
-
- -
  - (data: Data): Response
  - -
    -
    Parameters
    -
    - -
      data: Data
    -
    Returns Response

mainWorker: undefined | null | 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.

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

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

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

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

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

Methods

asyncId

asyncId(): number

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

bind

bind<Func>(fn: Func): Func & {
Â Â Â Â asyncResource: AsyncResource;
}

bind<Func>(fn): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Binds the given function to execute to this AsyncResource's scope.

The returned function will have an asyncResource property referencing @@ -201,32 +190,32 @@ the AsyncResource to which the function is bound.

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

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

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

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

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

`Private` checkFunctionInput

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

checkFunctionInput(fn): void
Checks if the fn parameter is passed to the constructor.

@@ -234,40 +223,29 @@ the AsyncResource to which the function is bound.

Parameters
- -
  fn: ((data: Data) => Response)
  +
  fn: WorkerFunction<Data, Response>
  
  The function that should be defined.
  -
  -
  - -
    - (data: Data): Response
    - -
      -
      Parameters
      -
      -
      -
      data: Data
      -
      Returns Response

Returns void

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

`Private` checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void

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

Returns void

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

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 @@ -276,26 +254,26 @@ never be called.

Returns
A reference to asyncResource.

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

`Protected` getMainWorker

getMainWorker(): MainWorker

getMainWorker(): MainWorker
Returns the main worker.

Returns
Reference to the main worker.

-
Returns MainWorker
+
Returns MainWorker
- Defined in src/worker/abstract-worker.ts:129

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

`Protected` handleError

handleError(e: string | Error): string

handleError(e): string
Handles an error and convert it to a string so it can be sent back to the main worker.
@@ -305,16 +283,16 @@ never be called.

Parameters
- -
  e: string | Error
  +
  e: string | Error
  
  The error raised by the worker.
Returns string
- Defined in src/worker/abstract-worker.ts:161

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

`Protected` messageListener

messageListener(message: MessageValue<Data, MainWorker>, fn: ((data: Data) => Response)): void

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

@@ -322,31 +300,20 @@ never be called.

Parameters
- -
  message: MessageValue<Data, MainWorker>
  +
  message: MessageValue<Data, MainWorker>
  
  Message received.
- -
  fn: ((data: Data) => Response)
  +
  fn: WorkerFunction<Data, Response>
  
  Function processed by the worker when the pool's execution function is invoked.
  -
  -
  - -
    - (data: Data): Response
    - -
      -
      Parameters
      -
      -
      -
      data: Data
      -
      Returns Response
+

Returns void

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

`Protected` run

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

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

@@ -354,31 +321,20 @@ never be called.

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

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

`Protected` runAsync

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

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

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

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

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 @@ -423,45 +368,45 @@ then restore the original execution context.

Type Parameters
- -
  This
- -
  Result

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

triggerAsyncId

triggerAsyncId(): number

triggerAsyncId(): number
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
@@ -487,10 +432,10 @@ then restore the original execution context.

Inherited from AsyncResource.triggerAsyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
Â Â Â Â asyncResource: AsyncResource;
}

bind<Func, ThisArg>(fn, type?, thisArg?): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Binds the given function to the current execution context.

The returned function will have an asyncResource property referencing @@ -502,23 +447,23 @@ the AsyncResource to which the function is bound.

Type Parameters
- -
  Func extends ((this: ThisArg, ...args: any[]) => any)
- -
  ThisArg

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

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

`Optional` thisArg: ThisArg

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

@@ -536,73 +481,76 @@ the AsyncResource to which the function is bound.

Theme

WorkerChoiceStrategyContext

ClusterPoolOptions

IPool

IWorker

IWorkerChoiceStrategy

MessageValue

PoolOptions

PromiseResponseWrapper

WorkerChoiceStrategyOptions

ThreadWorkerWithMessageChannel

WorkerChoiceStrategies

Generated using TypeDoc

\ No newline at end of file

Constructors

Properties

Methods

Type Parameters

MainWorker extends Worker | MessagePort

MainWorker extends Worker | MessagePort

Data = unknown

Data = unknown

Response = unknown

Parameters

data: Data

Returns Response

Returns

Type Parameters

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

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

fn: WorkerFunction<Data, Response>

Parameters

data: Data

Returns Response

e: string | Error

e: string | Error

Parameters

data: Data

Returns Response

Parameters

Optional data: Data

Returns Response

Parameters

Optional data: Data

Returns Promise<Response>

This

Result

Parameters

this: This

this: This

Rest ...args: any[]

Returns Result

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

ThisArg

`Optional` data: Data

`Optional` data: Data

`Rest` ...args: any[]