Commit | Line | Data |
---|---|---|
f59e1027 JB |
1 | import { |
2 | type MessagePort, | |
3 | isMainThread, | |
4 | parentPort, | |
5 | threadId | |
6 | } from 'node:worker_threads' | |
b6b32453 | 7 | import type { MessageValue } from '../utility-types' |
c97c7edb | 8 | import { AbstractWorker } from './abstract-worker' |
325f50bc | 9 | import type { WorkerOptions } from './worker-options' |
82ea6492 | 10 | import type { TaskFunction, TaskFunctions } from './task-functions' |
a32e02ba | 11 | |
a32e02ba | 12 | /** |
729c563d | 13 | * A thread worker used by a poolifier `ThreadPool`. |
4ade5f1f | 14 | * |
729c563d S |
15 | * When this worker is inactive for more than the given `maxInactiveTime`, |
16 | * it will send a termination request to its main thread. | |
17 | * | |
18 | * If you use a `DynamicThreadPool` the extra workers that were created will be terminated, | |
19 | * but the minimum number of workers will be guaranteed. | |
20 | * | |
e102732c JB |
21 | * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data. |
22 | * @typeParam Response - Type of response the worker sends back to the main thread. This can only be structured-cloneable data. | |
4ade5f1f | 23 | * @author [Alessandro Pio Ardizio](https://github.com/pioardi) |
a32e02ba | 24 | * @since 0.0.1 |
25 | */ | |
d3c8a1a8 | 26 | export class ThreadWorker< |
deb85c12 JB |
27 | Data = unknown, |
28 | Response = unknown | |
d3c8a1a8 | 29 | > extends AbstractWorker<MessagePort, Data, Response> { |
85aeb3f3 | 30 | /** |
2761efb4 | 31 | * Message port used to communicate with the main worker. |
85aeb3f3 | 32 | */ |
9b5c72ff | 33 | private port?: MessagePort |
729c563d S |
34 | /** |
35 | * Constructs a new poolifier thread worker. | |
36 | * | |
82888165 | 37 | * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. |
38e795c1 | 38 | * @param opts - Options for the worker. |
729c563d | 39 | */ |
d4aeae5a | 40 | public constructor ( |
82ea6492 | 41 | taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>, |
d4aeae5a JB |
42 | opts: WorkerOptions = {} |
43 | ) { | |
9b5c72ff | 44 | super(isMainThread, parentPort as MessagePort, taskFunctions, opts) |
f59e1027 JB |
45 | } |
46 | ||
85aeb3f3 JB |
47 | /** @inheritDoc */ |
48 | protected handleReadyMessage (message: MessageValue<Data>): void { | |
49 | if ( | |
50 | message.workerId === this.id && | |
f05ed93c | 51 | message.ready === false && |
85aeb3f3 JB |
52 | message.port != null |
53 | ) { | |
f05ed93c JB |
54 | try { |
55 | this.port = message.port | |
56 | this.port.on('message', this.messageListener.bind(this)) | |
a5d15204 JB |
57 | this.sendToMainWorker({ |
58 | ready: true, | |
895b5341 | 59 | taskFunctionNames: this.listTaskFunctionNames() |
a5d15204 | 60 | }) |
f05ed93c | 61 | } catch { |
a5d15204 JB |
62 | this.sendToMainWorker({ |
63 | ready: false, | |
895b5341 | 64 | taskFunctionNames: this.listTaskFunctionNames() |
a5d15204 | 65 | }) |
f05ed93c | 66 | } |
85aeb3f3 JB |
67 | } |
68 | } | |
69 | ||
984dc9c8 | 70 | /** @inheritDoc */ |
d655027b | 71 | protected handleKillMessage (message: MessageValue<Data>): void { |
984dc9c8 JB |
72 | super.handleKillMessage(message) |
73 | this.port?.unref() | |
74 | this.port?.close() | |
75 | } | |
76 | ||
85aeb3f3 | 77 | /** @inheritDoc */ |
f59e1027 JB |
78 | protected get id (): number { |
79 | return threadId | |
106744f7 | 80 | } |
7784f548 | 81 | |
afc003b2 | 82 | /** @inheritDoc */ |
803f948f JB |
83 | protected readonly sendToMainWorker = ( |
84 | message: MessageValue<Response> | |
85 | ): void => { | |
9b5c72ff | 86 | this.port?.postMessage({ ...message, workerId: this.id }) |
7784f548 | 87 | } |
985d0e79 | 88 | |
34d8846f JB |
89 | /** |
90 | * @inheritDoc | |
91 | * @override | |
92 | */ | |
646bced2 JB |
93 | protected handleError (error: Error | string): string { |
94 | return error as string | |
985d0e79 | 95 | } |
a32e02ba | 96 | } |