Commit | Line | Data |
---|---|---|
fa699c42 | 1 | import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads' |
d3c8a1a8 | 2 | import type { Draft, JSONValue, MessageValue } from '../../utility-types' |
c97c7edb S |
3 | import type { PoolOptions } from '../abstract-pool' |
4 | import { AbstractPool } from '../abstract-pool' | |
4ade5f1f | 5 | |
729c563d S |
6 | /** |
7 | * A thread worker with message channels for communication between main thread and thread worker. | |
8 | */ | |
c97c7edb | 9 | export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel> |
4ade5f1f S |
10 | |
11 | /** | |
729c563d S |
12 | * A thread pool with a fixed number of threads. |
13 | * | |
14 | * It is possible to perform tasks in sync or asynchronous mode as you prefer. | |
15 | * | |
16 | * This pool selects the threads in a round robin fashion. | |
4ade5f1f | 17 | * |
729c563d S |
18 | * @template Data Type of data sent to the worker. |
19 | * @template Response Type of response of execution. | |
4ade5f1f S |
20 | * |
21 | * @author [Alessandro Pio Ardizio](https://github.com/pioardi) | |
22 | * @since 0.0.1 | |
23 | */ | |
d3c8a1a8 S |
24 | export class FixedThreadPool< |
25 | Data extends JSONValue = JSONValue, | |
26 | Response extends JSONValue = JSONValue | |
27 | > extends AbstractPool<ThreadWorkerWithMessageChannel, Data, Response> { | |
4ade5f1f | 28 | /** |
729c563d S |
29 | * Constructs a new poolifier fixed thread pool. |
30 | * | |
5c5a1fb7 | 31 | * @param numberOfThreads Number of threads for this pool. |
729c563d S |
32 | * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute. |
33 | * @param opts Options for this fixed thread pool. Default: `{ maxTasks: 1000 }` | |
4ade5f1f S |
34 | */ |
35 | public constructor ( | |
5c5a1fb7 | 36 | numberOfThreads: number, |
c97c7edb S |
37 | filePath: string, |
38 | opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 } | |
4ade5f1f | 39 | ) { |
5c5a1fb7 | 40 | super(numberOfThreads, filePath, opts) |
c97c7edb | 41 | } |
4ade5f1f | 42 | |
c97c7edb S |
43 | protected isMain (): boolean { |
44 | return isMainThread | |
4ade5f1f S |
45 | } |
46 | ||
c97c7edb S |
47 | protected async destroyWorker ( |
48 | worker: ThreadWorkerWithMessageChannel | |
49 | ): Promise<void> { | |
cefac5ba | 50 | this.sendToWorker(worker, { kill: 1 }) |
c97c7edb | 51 | await worker.terminate() |
4ade5f1f S |
52 | } |
53 | ||
c97c7edb S |
54 | protected sendToWorker ( |
55 | worker: ThreadWorkerWithMessageChannel, | |
56 | message: MessageValue<Data> | |
57 | ): void { | |
58 | worker.postMessage(message) | |
4ade5f1f S |
59 | } |
60 | ||
4f7fa42a S |
61 | protected registerWorkerMessageListener<Message extends Data | Response> ( |
62 | messageChannel: ThreadWorkerWithMessageChannel, | |
63 | listener: (message: MessageValue<Message>) => void | |
c97c7edb | 64 | ): void { |
4f7fa42a | 65 | messageChannel.port2?.on('message', listener) |
4ade5f1f S |
66 | } |
67 | ||
4f7fa42a S |
68 | protected unregisterWorkerMessageListener<Message extends Data | Response> ( |
69 | messageChannel: ThreadWorkerWithMessageChannel, | |
70 | listener: (message: MessageValue<Message>) => void | |
c97c7edb | 71 | ): void { |
4f7fa42a | 72 | messageChannel.port2?.removeListener('message', listener) |
4ade5f1f S |
73 | } |
74 | ||
280c2a77 | 75 | protected createWorker (): ThreadWorkerWithMessageChannel { |
c97c7edb | 76 | return new Worker(this.filePath, { |
4ade5f1f S |
77 | env: SHARE_ENV |
78 | }) | |
c97c7edb S |
79 | } |
80 | ||
280c2a77 | 81 | protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void { |
4ade5f1f S |
82 | const { port1, port2 } = new MessageChannel() |
83 | worker.postMessage({ parent: port1 }, [port1]) | |
84 | worker.port1 = port1 | |
85 | worker.port2 = port2 | |
86 | // we will attach a listener for every task, | |
87 | // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size | |
ee99693b | 88 | worker.port2.setMaxListeners(this.opts.maxTasks ?? 1000) |
4ade5f1f S |
89 | } |
90 | } |