X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=752045829214f76681f92d36fce414c581fd0c95;hb=897beca72d8ea0b909f5c9cd6deb8c5e58b1dd7f;hp=55e15792b01f23a4305e42f3d4fe4689e7dbaf05;hpb=729c563db85562dd7d0f7733b1a3e2d98467134b;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 55e15792..75204582 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,19 +1,27 @@ +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. This can only be serializable data. + * @returns Promise that will be resolved when the task is successfully completed. + */ + execute(data: Data): Promise /** * Shut down every current worker in this pool. */ destroy(): Promise /** - * Perform the task specified in the constructor with the data parameter. + * Set the worker choice strategy in this pool. * - * @param data The input for the specified task. - * @returns Promise that will be resolved when the task is successfully completed. + * @param workerChoiceStrategy The worker choice strategy. */ - execute(data: Data): Promise + setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void }