ExitHandler,
IWorker,
MessageHandler,
- OnlineHandler
+ OnlineHandler,
+ WorkerNode
} from './worker'
import type {
WorkerChoiceStrategy,
WorkerChoiceStrategyOptions
} from './selection-strategies/selection-strategies-types'
+/**
+ * Pool types.
+ *
+ * @enum
+ * @internal
+ */
+export enum PoolType {
+ /**
+ * Fixed pool type.
+ */
+ FIXED = 'fixed',
+ /**
+ * Dynamic pool type.
+ */
+ DYNAMIC = 'dynamic'
+}
+
/**
* Pool events emitter.
*/
/**
* Options for a poolifier pool.
+ *
+ * @typeParam Worker - Type of worker.
*/
export interface PoolOptions<Worker extends IWorker> {
/**
exitHandler?: ExitHandler<Worker>
/**
* The worker choice strategy to use in this pool.
+ *
+ * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
*/
workerChoiceStrategy?: WorkerChoiceStrategy
/**
/**
* Pool worker tasks queue.
*
- * @experimental
* @defaultValue false
*/
enableTasksQueue?: boolean
/**
* Pool worker tasks queue options.
- *
- * @experimental
*/
tasksQueueOptions?: TasksQueueOptions
}
/**
* Contract definition for a poolifier pool.
*
+ * @typeParam Worker - Type of worker which manages this pool.
* @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.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
*/
-export interface IPool<Data = unknown, Response = unknown> {
+export interface IPool<
+ Worker extends IWorker,
+ Data = unknown,
+ Response = unknown
+> {
+ /**
+ * Pool type.
+ *
+ * If it is `'dynamic'`, it provides the `max` property.
+ */
+ readonly type: PoolType
+ /**
+ * Pool worker nodes.
+ */
+ readonly workerNodes: Array<WorkerNode<Worker, Data>>
/**
* Emitter on which events can be listened to.
*
*/
readonly emitter?: PoolEmitter
/**
- * Performs the task specified in the constructor with the data parameter.
+ * Finds a free worker node key based on the number of tasks the worker has applied.
+ *
+ * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
+ *
+ * If no free worker is found, `-1` is returned.
+ *
+ * @returns A worker node key if there is one, `-1` otherwise.
+ */
+ findFreeWorkerNodeKey: () => number
+ /**
+ * Executes the function specified in the constructor with the task data input parameter.
*
- * @param data - The input for the specified task. This can only be serializable data.
+ * @param data - The task input data for the specified function. This can only be serializable data.
* @returns Promise that will be resolved when the task is successfully completed.
*/
execute: (data: Data) => Promise<Response>
* Sets the worker choice strategy in this pool.
*
* @param workerChoiceStrategy - The worker choice strategy.
+ * @param workerChoiceStrategyOptions - The worker choice strategy options.
+ */
+ setWorkerChoiceStrategy: (
+ workerChoiceStrategy: WorkerChoiceStrategy,
+ workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+ ) => void
+ /**
+ * Sets the worker choice strategy options in this pool.
+ *
+ * @param workerChoiceStrategyOptions - The worker choice strategy options.
+ */
+ setWorkerChoiceStrategyOptions: (
+ workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+ ) => void
+ /**
+ * Enables/disables the worker tasks queue in this pool.
+ *
+ * @param enable - Whether to enable or disable the worker tasks queue.
+ * @param tasksQueueOptions - The worker tasks queue options.
+ */
+ enableTasksQueue: (
+ enable: boolean,
+ tasksQueueOptions?: TasksQueueOptions
+ ) => void
+ /**
+ * Sets the worker tasks queue options in this pool.
+ *
+ * @param tasksQueueOptions - The worker tasks queue options.
*/
- setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
+ setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
}