1 import { isMainThread
, MessageChannel
, SHARE_ENV
, Worker
} from
'worker_threads'
2 import type { Draft
, MessageValue
} from
'../../utility-types'
3 import type { PoolOptions
} from
'../abstract-pool'
4 import { AbstractPool
} from
'../abstract-pool'
5 import { PoolType
} from
'../pool-internal'
8 * A thread worker with message channels for communication between main thread and thread worker.
10 export type ThreadWorkerWithMessageChannel
= Worker
& Draft
<MessageChannel
>
13 * A thread pool with a fixed number of threads.
15 * It is possible to perform tasks in sync or asynchronous mode as you prefer.
17 * This pool selects the threads in a round robin fashion.
19 * @template Data Type of data sent to the worker. This can only be serializable data.
20 * @template Response Type of response of execution. This can only be serializable data.
22 * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
25 export class FixedThreadPool
<
28 > extends AbstractPool
<ThreadWorkerWithMessageChannel
, Data
, Response
> {
30 * Constructs a new poolifier fixed thread pool.
32 * @param numberOfThreads Number of threads for this pool.
33 * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
34 * @param opts Options for this fixed thread pool. Default: `{}`
37 numberOfThreads
: number,
39 opts
: PoolOptions
<ThreadWorkerWithMessageChannel
> = {}
41 super(numberOfThreads
, filePath
, opts
)
44 protected isMain (): boolean {
49 public async destroyWorker (
50 worker
: ThreadWorkerWithMessageChannel
52 this.sendToWorker(worker
, { kill
: 1 })
53 await worker
.terminate()
56 protected sendToWorker (
57 worker
: ThreadWorkerWithMessageChannel
,
58 message
: MessageValue
<Data
>
60 worker
.postMessage(message
)
64 public registerWorkerMessageListener
<Message
extends Data
| Response
> (
65 messageChannel
: ThreadWorkerWithMessageChannel
,
66 listener
: (message
: MessageValue
<Message
>) => void
68 messageChannel
.port2
?.on('message', listener
)
71 protected createWorker (): ThreadWorkerWithMessageChannel
{
72 return new Worker(this.filePath
, {
77 protected afterWorkerSetup (worker
: ThreadWorkerWithMessageChannel
): void {
78 const { port1
, port2
} = new MessageChannel()
79 worker
.postMessage({ parent: port1
}, [port1
])
82 // Listen worker messages.
83 this.registerWorkerMessageListener(worker
, super.workerListener())
87 public get
type (): PoolType
{
92 public get
busy (): boolean {
93 return this.internalGetBusyStatus()