X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=752045829214f76681f92d36fce414c581fd0c95;hb=897beca72d8ea0b909f5c9cd6deb8c5e58b1dd7f;hp=f96e5c0cbff3ed84afe5d06c6ac8f2097539ba9f;hpb=280c2a7728fbeb53612d8bc115a295d0255dd991;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index f96e5c0c..75204582 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,14 +1,16 @@ +import type { WorkerChoiceStrategy } from './selection-strategies' + /** * Contract definition for a poolifier pool. * - * @template Data Type of data sent to the worker. - * @template Response Type of response of execution. + * @template Data Type of data sent to the worker. This can only be serializable data. + * @template Response Type of response of execution. This can only be serializable data. */ export interface IPool { /** * Perform the task specified in the constructor with the data parameter. * - * @param data The input for the specified task. + * @param data The input for the specified task. This can only be serializable data. * @returns Promise that will be resolved when the task is successfully completed. */ execute(data: Data): Promise @@ -16,4 +18,10 @@ export interface IPool { * Shut down every current worker in this pool. */ destroy(): Promise + /** + * Set the worker choice strategy in this pool. + * + * @param workerChoiceStrategy The worker choice strategy. + */ + setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void }