X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=src%2Fpools%2Fpool.ts;h=6f677da8ba64d695e5b4b82f904f4b21ef1c7208;hb=2377984dc95d13e0a684210368e3e4d4ba6239d6;hp=f48d8843d9596f914f60ae1349ff258af7df4518;hpb=deb85c12b77faf6974551cefcd9676e62a392086;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index f48d8843..6f677da8 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,3 +1,43 @@ +import type { + ErrorHandler, + ExitHandler, + MessageHandler, + OnlineHandler +} from './pool-worker' +import type { WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types' + +/** + * Options for a poolifier pool. + */ +export interface PoolOptions { + /** + * A function that will listen for message event on each worker. + */ + messageHandler?: MessageHandler + /** + * A function that will listen for error event on each worker. + */ + errorHandler?: ErrorHandler + /** + * A function that will listen for online event on each worker. + */ + onlineHandler?: OnlineHandler + /** + * A function that will listen for exit event on each worker. + */ + exitHandler?: ExitHandler + /** + * The work choice strategy to use in this pool. + */ + workerChoiceStrategy?: WorkerChoiceStrategy + /** + * Pool events emission. + * + * @default true + */ + enableEvents?: boolean +} + /** * Contract definition for a poolifier pool. * @@ -13,7 +53,13 @@ export interface IPool { */ execute(data: Data): Promise /** - * Shut down every current worker in this pool. + * Shutdowns 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 }