X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=212253ffbc5be7faff8760dc3847f9cdc486bb89;hb=f4d1dbd1592e24d7a09f35013c3e0f0762240254;hp=6156a0421170e6baa8ad7c2071b755da554a03ed;hpb=c172526cd82999efbace45402e0bd6d9ae173963;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 6156a042..212253ff 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -64,6 +64,7 @@ export interface PoolInfo { readonly version: string readonly type: PoolType readonly worker: WorkerType + readonly started: boolean readonly ready: boolean readonly strategy: WorkerChoiceStrategy readonly minSize: number @@ -107,16 +108,24 @@ export interface TasksQueueOptions { * @defaultValue (pool maximum size)^2 */ readonly size?: number - /** - * @deprecated Use `size` instead. - */ - readonly queueMaxSize?: number /** * Maximum number of tasks that can be executed concurrently on a worker node. * * @defaultValue 1 */ readonly concurrency?: number + /** + * Whether to enable task stealing. + * + * @defaultValue true + */ + readonly taskStealing?: boolean + /** + * Whether to enable tasks stealing on back pressure. + * + * @defaultValue true + */ + readonly tasksStealingOnBackPressure?: boolean } /** @@ -127,20 +136,34 @@ export interface TasksQueueOptions { export interface PoolOptions { /** * A function that will listen for online event on each worker. + * + * @defaultValue `() => {}` */ onlineHandler?: OnlineHandler /** * A function that will listen for message event on each worker. + * + * @defaultValue `() => {}` */ messageHandler?: MessageHandler /** * A function that will listen for error event on each worker. + * + * @defaultValue `() => {}` */ errorHandler?: ErrorHandler /** * A function that will listen for exit event on each worker. + * + * @defaultValue `() => {}` */ exitHandler?: ExitHandler + /** + * Whether to start the minimum number of workers at pool initialization. + * + * @defaultValue true + */ + startWorkers?: boolean /** * The worker choice strategy to use in this pool. * @@ -230,6 +253,10 @@ export interface IPool< name?: string, transferList?: TransferListItem[] ) => Promise + /** + * Starts the minimum number of workers in this pool. + */ + readonly start: () => void /** * Terminates all workers in this pool. */ @@ -251,15 +278,15 @@ export interface IPool< */ readonly addTaskFunction: ( name: string, - taskFunction: TaskFunction - ) => boolean + taskFunction: TaskFunction + ) => Promise /** * Removes a task function from this pool. * * @param name - The name of the task function. * @returns `true` if the task function was removed, `false` otherwise. */ - readonly removeTaskFunction: (name: string) => boolean + readonly removeTaskFunction: (name: string) => Promise /** * Lists the names of task function available in this pool. * @@ -272,7 +299,7 @@ export interface IPool< * @param name - The name of the task function. * @returns `true` if the default task function was set, `false` otherwise. */ - readonly setDefaultTaskFunction: (name: string) => boolean + readonly setDefaultTaskFunction: (name: string) => Promise /** * Sets the worker choice strategy in this pool. *