X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=93f4694004b0290113fc74ab1cb6a676cc29565e;hb=460aaab4b4cb6857827d3e56e11122bffc01db8a;hp=394e14c9f03a68fa75aa5f00554442a72060ac1e;hpb=6047493a00c2852f2c7f4329def8e1322c678cf1;p=poolifier.git
diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html
index 394e14c9..93f46940 100644
--- a/docs/interfaces/IPool.html
+++ b/docs/interfaces/IPool.html
@@ -1,4 +1,4 @@
-
IPool | poolifier
+IPool | poolifier
@@ -18,19 +18,19 @@
-
+
Type Parameters
-
+
-
-
Worker extends IWorker
+Worker extends IWorker
-
-
Data = unknown
+Data = unknown
-
-
Response = unknown
+Response = unknown
+Defined in src/pools/pool.ts:156
@@ -50,55 +50,56 @@
Properties
-
+
destroy
-destroy: (() => Promise<void>)
+destroy: (() => Promise<void>)
Type declaration
-
-
-- (): Promise<void>
+
+- (): Promise<void>
-
-
Returns Promise<void>
-
+
Optional
Readonly
emitter
-
+
-
+
enableTasksQueue
-
+enableTasksQueue: ((enable, tasksQueueOptions?) => void)
Type declaration
-
-
-- (enable: boolean, opts?: TasksQueueOptions): void
+
+- (enable, tasksQueueOptions?): void
-
@@ -106,66 +107,59 @@
Parameters
-
-
enable: boolean
+enable: boolean
-
-
+
+
Returns void
-
+
execute
-execute: ((data: Data) => Promise<Response>)
+execute: ((data?, name?) => Promise<Response>)
Type declaration
-
-
-- (data: Data): Promise<Response>
+
+- (data?, name?): Promise<Response>
-
-
-
-
findFreeWorkerNodeKey
-findFreeWorkerNodeKey: (() => number)
-
-
Type declaration
-
--
-
-- (): number
--
-
-
Returns number
+
-
+
setTasksQueueOptions
-
+setTasksQueueOptions: ((tasksQueueOptions) => void)
Type declaration
-
-
-- (tasksQueueOptions: TasksQueueOptions): void
+
+- (tasksQueueOptions): void
-
@@ -173,21 +167,21 @@
Parameters
Returns void
-
+
setWorkerChoiceStrategy
-setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
+setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
Type declaration
-
-
-- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+
+- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
@@ -195,21 +189,25 @@
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+-
+
+
Returns void
-
+
setWorkerChoiceStrategyOptions
-
+setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
Type declaration
-
-
-- (workerChoiceStrategyOptions: WorkerChoiceStrategyOptions): void
+
+- (workerChoiceStrategyOptions): void
-
@@ -217,27 +215,19 @@
Parameters
Returns void
-
-
+
+Defined in src/pools/pool.ts:168
+Theme
On This Page
+destroy
+emitter
+enableTasksQueue
+execute
+info
+setTasksQueueOptions
+setWorkerChoiceStrategy
+setWorkerChoiceStrategyOptions
+workerNodes
+AbstractPool
+AbstractWorker
+CircularArray
+ClusterWorker
+DynamicClusterPool
+DynamicThreadPool
+FixedClusterPool
+FixedThreadPool
+PoolEmitter
+Queue
+ThreadWorker
+WorkerChoiceStrategyContext
+ClusterPoolOptions
+IPool
+IWorker
+IWorkerChoiceStrategy
+MessageValue
+PoolInfo
+PoolOptions
+PromiseResponseWrapper
+RequiredStatistics
+Task
+TasksQueueOptions
+TasksUsage
+WorkerChoiceStrategyOptions
+WorkerNode
+WorkerOptions
+Draft
+ErrorHandler
+ExitHandler
+KillBehavior
+MessageHandler
+OnlineHandler
+PoolEvent
+PoolType
+TaskFunctions
+ThreadWorkerWithMessageChannel
+WorkerAsyncFunction
+WorkerChoiceStrategy
+WorkerFunction
+WorkerSyncFunction
+WorkerType
+KillBehaviors
+PoolEvents
+PoolTypes
+WorkerChoiceStrategies
+WorkerTypes
\ No newline at end of file
Contract definition for a poolifier pool.