-import EventEmitter from 'events'
-import type { IWorker } from './abstract-pool'
import type { IPool } from './pool'
+import type { IWorker, WorkerNode } from './worker'
/**
- * Pool types.
+ * Internal pool types.
+ *
+ * @enum
*/
export enum PoolType {
+ /**
+ * Fixed pool type.
+ */
FIXED = 'fixed',
+ /**
+ * Dynamic pool type.
+ */
DYNAMIC = 'dynamic'
}
-/**
- * Internal poolifier pool emitter.
- */
-export class PoolEmitter extends EventEmitter {}
-
/**
* Internal contract definition for a poolifier pool.
*
- * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @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.
*/
export interface IPoolInternal<
Worker extends IWorker,
Response = unknown
> extends IPool<Data, Response> {
/**
- * List of currently available workers.
+ * Pool worker nodes.
*/
- readonly workers: Worker[]
-
- /**
- * The tasks map.
- *
- * - `key`: The `Worker`
- * - `value`: Number of tasks currently in progress on the worker.
- */
- readonly tasks: Map<Worker, number>
-
- /**
- * Emitter on which events can be listened to.
- *
- * Events that can currently be listened to:
- *
- * - `'busy'`
- */
- readonly emitter?: PoolEmitter
+ readonly workerNodes: Array<WorkerNode<Worker, Data>>
/**
* Pool type.
readonly type: PoolType
/**
- * Maximum number of workers that can be created by this pool.
+ * Whether the pool is full or not.
+ *
+ * The pool filling boolean status.
*/
- readonly max?: number
+ readonly full: boolean
/**
* Whether the pool is busy or not.
readonly busy: boolean
/**
- * Number of tasks currently concurrently running.
- */
- readonly numberOfRunningTasks: number
-
- /**
- * Find a tasks map entry with a free worker based on the number of tasks the worker has applied.
+ * Finds a free worker node key based on the number of tasks the worker has applied.
*
- * If an entry is found with a worker that has `0` tasks, it is detected as free.
+ * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
*
- * If no tasks map entry with a free worker was found, `false` will be returned.
+ * If no free worker is found, `-1` is returned.
*
- * @returns A tasks map entry with a free worker if there was one, otherwise `false`.
+ * @returns A worker node key if there is one, `-1` otherwise.
*/
- findFreeTasksMapEntry(): [Worker, number] | false
+ findFreeWorkerNodeKey: () => number
}