5 } from
'node:worker_threads'
6 import type { MessageValue
} from
'../../utility-types.js'
7 import { AbstractPool
} from
'../abstract-pool.js'
8 import { type PoolOptions
, type PoolType
, PoolTypes
} from
'../pool.js'
9 import { type WorkerType
, WorkerTypes
} from
'../worker.js'
12 * Options for a poolifier thread pool.
14 export type ThreadPoolOptions
= PoolOptions
<Worker
>
17 * A thread pool with a fixed number of threads.
19 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
20 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
21 * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
24 export class FixedThreadPool
<
27 > extends AbstractPool
<Worker
, Data
, Response
> {
29 * Constructs a new poolifier fixed thread pool.
31 * @param numberOfThreads - Number of threads for this pool.
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.
36 numberOfThreads
: number,
38 opts
: ThreadPoolOptions
= {},
39 maximumNumberOfThreads
?: number
41 super(numberOfThreads
, filePath
, opts
, maximumNumberOfThreads
)
45 protected isMain (): boolean {
50 protected sendToWorker (
51 workerNodeKey
: number,
52 message
: MessageValue
<Data
>,
53 transferList
?: TransferListItem
[]
55 this.workerNodes
[workerNodeKey
].messageChannel
?.port1
.postMessage(
56 { ...message
, workerId
: this.getWorkerInfo(workerNodeKey
)?.id
},
62 protected sendStartupMessageToWorker (workerNodeKey
: number): void {
63 const workerNode
= this.workerNodes
[workerNodeKey
]
64 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
65 const port2
= workerNode
.messageChannel
!.port2
66 workerNode
.worker
.postMessage(
69 workerId
: this.getWorkerInfo(workerNodeKey
)?.id
,
77 protected registerWorkerMessageListener
<Message
extends Data
| Response
>(
78 workerNodeKey
: number,
79 listener
: (message
: MessageValue
<Message
>) => void
81 this.workerNodes
[workerNodeKey
].messageChannel
?.port1
.on(
88 protected registerOnceWorkerMessageListener
<Message
extends Data
| Response
>(
89 workerNodeKey
: number,
90 listener
: (message
: MessageValue
<Message
>) => void
92 this.workerNodes
[workerNodeKey
].messageChannel
?.port1
.once(
99 protected deregisterWorkerMessageListener
<Message
extends Data
| Response
>(
100 workerNodeKey
: number,
101 listener
: (message
: MessageValue
<Message
>) => void
103 this.workerNodes
[workerNodeKey
].messageChannel
?.port1
.off(
110 protected shallCreateDynamicWorker (): boolean {
115 protected checkAndEmitDynamicWorkerCreationEvents (): void {
120 protected get
type (): PoolType
{
121 return PoolTypes
.fixed
125 protected get
worker (): WorkerType
{
126 return WorkerTypes
.thread
130 protected get
busy (): boolean {
131 return this.internalBusy()