*
* This pool selects the threads in a round robin fashion.
*
- * @template DataType of data sent to the worker. This can only be serializable data.
- * @template ResponseType of response of execution. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
* @author [Alessandro Pio Ardizio](https://github.com/pioardi)
* @since 0.0.1
*/
/**
* Constructs a new poolifier fixed thread pool.
*
- * @param numberOfThreads Number of threads for this pool.
- * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
- * @param [opts={}] Options for this fixed thread pool.
+ * @param numberOfThreads - Number of threads for this pool.
+ * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
+ * @param opts - Options for this fixed thread pool.
*/
public constructor (
numberOfThreads: number,
super(numberOfThreads, filePath, opts)
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
protected isMain (): boolean {
return isMainThread
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public async destroyWorker (
worker: ThreadWorkerWithMessageChannel
): Promise<void> {
await worker.terminate()
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
protected sendToWorker (
worker: ThreadWorkerWithMessageChannel,
message: MessageValue<Data>
worker.postMessage(message)
}
- /** @inheritdoc */
- public registerWorkerMessageListener<Message extends Data | Response> (
+ /** {@inheritDoc} */
+ public registerWorkerMessageListener<Message extends Data | Response>(
messageChannel: ThreadWorkerWithMessageChannel,
listener: (message: MessageValue<Message>) => void
): void {
messageChannel.port2?.on('message', listener)
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
protected createWorker (): ThreadWorkerWithMessageChannel {
return new Worker(this.filePath, {
env: SHARE_ENV
})
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void {
const { port1, port2 } = new MessageChannel()
worker.postMessage({ parent: port1 }, [port1])
worker.port1 = port1
worker.port2 = port2
- // Listen worker messages.
+ // Listen to worker messages.
this.registerWorkerMessageListener(worker, super.workerListener())
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public get type (): PoolType {
return PoolType.FIXED
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public get busy (): boolean {
return this.internalGetBusyStatus()
}