ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=cffee599edbc9c129576b25fb261046c49a99f52;hb=b667be1103b9362ae29d094de05f812468464d4f;hp=aa550ec10ab952b5ebf03fff382f19a199575c92;hpb=3a592a1254b999797590d1b54662b747eed17528;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index aa550ec1..cffee599 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier

+ThreadWorker | poolifier - v2.6.8

@@ -21,22 +21,25 @@ it will send a termination request to its main thread.

If you use a DynamicThreadPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.

Author

Alessandro Pio Ardizio

Author

Alessandro Pio Ardizio

- -

Since

0.0.1

Since

0.0.1

Type Parameters

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

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

Hierarchy

ThreadWorker

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

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

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

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

Accessors

Constructors

constructor

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

@@ -98,82 +107,118 @@ but the minimum number of workers will be guaranteed.

Parameters
- -
  fn: WorkerFunction<Data, Response>
  -
  Function processed by the worker when the pool's execution function is invoked.
  -
- opts: WorkerOptions = {}
  
  Options for the worker.
  -

Returns ThreadWorker<Data, Response>

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

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

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

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

Accessors

`Protected` id

get id(): number
+
Worker id.
+
+
Returns number
+
+
Overrides AbstractWorker.id
+
- Defined in src/worker/thread-worker.ts:51

Methods

asyncId

asyncId(): number
asyncId(): number
-

Returns number
The unique asyncId assigned to the resource.
-
+ +
Inherited from AbstractWorker.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

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
@@ -186,26 +231,31 @@ the AsyncResource to which the function is bound.

fn: Func

The function to bind to the current AsyncResource.
-

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

Defined in node_modules/.pnpm/@types+node@20.4.0/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
+
Returns void
+
Inherited from AbstractWorker.checkAlive
- Defined in src/worker/abstract-worker.ts:156

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

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 @@ -213,26 +263,28 @@ the resource is left to be collected by the GC then the destroy hoo never be called.

Returns ThreadWorker<Data, Response>
A reference to asyncResource.
-
+ +
Inherited from AbstractWorker.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

`Protected` getMainWorker

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

Returns MessagePort
Reference to the main worker.
-
+ +
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:139

`Protected` handleError

handleError(e): string
Defined in src/worker/abstract-worker.ts:183

`Protected` handleError

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

@@ -242,16 +294,18 @@ never be called.
e: string | Error

The error raised by the worker.
-

Returns string

Message of the error.

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

`Protected` messageListener

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

@@ -259,43 +313,19 @@ never be called.

Parameters
- -
  message: MessageValue<Data, MessagePort>
  +
  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
-
Inherited from AbstractWorker.messageListener
-
- 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
-
Inherited from AbstractWorker.run
+

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.

@@ -305,26 +335,27 @@ 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:264

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
@@ -340,6 +371,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 AbstractWorker.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
+
+
Inherited from AbstractWorker.runSync
+
- Defined in src/worker/abstract-worker.ts:227

`Protected` sendToMainWorker

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

@@ -378,32 +440,30 @@ then restore the original execution context.
message: MessageValue<Response, unknown>

The response message.
-

Returns void

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

triggerAsyncId

triggerAsyncId(): number
triggerAsyncId(): number
-

Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
-
+ +
Inherited from AbstractWorker.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
@@ -418,22 +478,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.
-