ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=8b5d3d325dd55c13f829d6cf2400f48bc749cf70;hb=fbc22127e53d3ec0ecbd38ecea25fb92ebef50e7;hp=d432e78534adfbf6482a685f243b588ba35a1507;hpb=69f8ce0ab8ce1afcf350b21796496b8dcd2aaec1;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index d432e785..8b5d3d32 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier

+ThreadWorker | poolifier

@@ -52,37 +52,38 @@ but the minimum number of workers will be guaranteed.

Constructors

constructor +

constructor

Properties

aliveInterval? -lastTaskTimestamp -mainWorker -opts +

aliveInterval? +isMain +lastTaskTimestamp +mainWorker +opts

Constructors

constructor

new ThreadWorker<Data, Response>(fn: ((data: Data) => Response), opts?: WorkerOptions): ThreadWorker<Data, Response>

new ThreadWorker<Data, Response>(fn, opts?): ThreadWorker<Data, Response>
Constructs a new poolifier thread worker.

@@ -90,85 +91,84 @@ but the minimum number of workers will be guaranteed.

Type Parameters
- -
  Data = unknown
- -
  Response = unknown

Response = unknown

Parameters

-
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

opts: WorkerOptions = {}

Options for the worker.

Returns ThreadWorker<Data, Response>

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler Id of the aliveInterval worker alive check.

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.

`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 | MessagePort

`Readonly` opts

opts: WorkerOptions

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.

Returns number
-
Inherited from AbstractWorker.asyncId
+
Inherited from AbstractWorker.asyncId
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:315

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 @@ -180,33 +180,33 @@ 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;
}

Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288

`Protected` checkAlive

checkAlive(): void

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

Returns void
-
Inherited from AbstractWorker.checkAlive
+
Inherited from AbstractWorker.checkAlive
- Defined in src/worker/abstract-worker.ts:141

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

emitDestroy

emitDestroy(): ThreadWorker<Data, Response>

emitDestroy(): ThreadWorker<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 @@ -215,27 +215,27 @@ never be called.

Returns
A reference to asyncResource.

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

Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311

`Protected` getMainWorker

getMainWorker(): MessagePort

getMainWorker(): MessagePort
Returns the main worker.

Returns
Reference to the main worker.

-
Returns MessagePort
-
Inherited from AbstractWorker.getMainWorker
+
Returns MessagePort
+
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:124

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.
@@ -245,44 +245,39 @@ never be called.

Parameters
- -
  e: string | Error
  +
  e: string | Error
  
  The error raised by the worker.
Returns string
-
Inherited from AbstractWorker.handleError
+
Inherited from AbstractWorker.handleError
- Defined in src/worker/abstract-worker.ts:156

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

`Protected` messageListener

messageListener(value: MessageValue<Data, MessagePort>, fn: ((data: Data) => Response)): void

messageListener(message, fn): void
+
Worker message listener.
+
Parameters
- -
  value: MessageValue<Data, MessagePort>
- -
  fn: ((data: Data) => Response)
  -
  - -
    - (data: Data): Response
    - -
      -
      Parameters
      -
      +
      message: MessageValue<Data, MessagePort>
      +
      Message received.
      +
      
      -
      data: Data
      -
      Returns Response
+
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:89

`Protected` run

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

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

@@ -290,32 +285,21 @@ 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

value: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

Input data for the given function.

Returns void

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

`Protected` runAsync

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

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

@@ -323,32 +307,21 @@ 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
-
Inherited from AbstractWorker.runAsync
+
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:189

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 @@ -361,73 +334,75 @@ 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

`Protected` sendToMainWorker

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

sendToMainWorker(message): void
-
-
Inherit Doc
+
Sends a message to the main worker.
+
Parameters
- -
  message: MessageValue<Response, unknown>
+
message: MessageValue<Response, unknown>
+
The response message.
+

Returns void

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

triggerAsyncId

triggerAsyncId(): number

triggerAsyncId(): number
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.

Returns number
-
Inherited from AbstractWorker.triggerAsyncId
+
Inherited from AbstractWorker.triggerAsyncId
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:320

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 @@ -439,30 +414,31 @@ 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;
}

+ + - -

+ +

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Constructors

Properties

Methods

Type Parameters

Data = unknown

Data = unknown

Response = unknown

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

fn: WorkerFunction<Data, Response>

Parameters

data: Data

Returns Response

Returns

Returns number

Type Parameters

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

Returns

Returns

Parameters

e: string | Error

e: string | Error

Parameters

value: MessageValue<Data, MessagePort>

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

Parameters

message: MessageValue<Data, MessagePort>

data: Data

Returns Response

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

fn: WorkerSyncFunction<Data, Response>

Parameters

Optional data: Data

Returns Response

Parameters

Optional data: Data

Returns Promise<Response>

Parameters

this: This

this: This

Rest ...args: any[]

Returns Result

`Optional` data: Data

`Optional` data: Data

`Rest` ...args: any[]