X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d9423ad5e85324d82ef60437a1e0f35259a04605;hb=801c948aadfa0041a7870accc0644efb4a31145d;hp=0c22722b96bf9a41becf44dc0b8b7c85a7cdf5be;hpb=8d98e603c79d8d00b2b6a33e5f732701a7466234;p=poolifier.git
diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html
index 0c22722b..d9423ad5 100644
--- a/docs/interfaces/IPool.html
+++ b/docs/interfaces/IPool.html
@@ -17,22 +17,26 @@
Interface IPool<Worker, Data, Response>
+
+
Type Parameters
-
Worker extends IWorker
+
+
-
Data = unknown
+
+
-
Response = unknown
+
+
+Defined in src/pools/pool.ts:158
@@ -50,20 +54,20 @@
Properties
-destroy
+destroy
destroy: (() => Promise<void>)
Type declaration
@@ -74,11 +78,12 @@
-Returns Promise<void>
+Defined in src/pools/pool.ts:193
-Optional
Readonly
emitter
+Optional
Readonly
emitter
+Defined in src/pools/pool.ts:181
-enableTasksQueue
+enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
Type declaration
@@ -109,16 +115,19 @@
enable: boolean
+
+
-Returns void
+Defined in src/pools/pool.ts:218
-execute
+execute
execute: ((data?, name?) => Promise<Response>)
Type declaration
@@ -135,24 +144,28 @@
Optional
data: Data
+
+
Optional
name: string
+
+
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
-
+Defined in src/pools/pool.ts:189
-Readonly
info
+Readonly
info
+Defined in src/pools/pool.ts:166
-setTasksQueueOptions
+setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
Type declaration
@@ -169,12 +182,14 @@
-Returns void
+Defined in src/pools/pool.ts:227
-setWorkerChoiceStrategy
+setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
Type declaration
@@ -189,18 +204,21 @@
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+
+
-Returns void
+Defined in src/pools/pool.ts:200
-setWorkerChoiceStrategyOptions
+setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
Type declaration
@@ -217,22 +235,25 @@
-Returns void
+Defined in src/pools/pool.ts:209
-Readonly
workerNodes
+Readonly
workerNodes
+Defined in src/pools/pool.ts:170
+AbstractPool
+AbstractWorker
+CircularArray
+ClusterWorker
+DynamicClusterPool
+DynamicThreadPool
+FixedClusterPool
+FixedThreadPool
+PoolEmitter
+Queue
+ThreadWorker
+WorkerChoiceStrategyContext
+ClusterPoolOptions
+EventLoopUtilizationMeasurementStatistics
+IPool
+IWorker
+IWorkerChoiceStrategy
+MeasurementOptions
+MeasurementStatistics
+MeasurementStatisticsRequirements
+MessageValue
+PoolInfo
+PoolOptions
+PromiseResponseWrapper
+Task
+TaskError
+TaskPerformance
+TaskStatistics
+TaskStatisticsRequirements
+TasksQueueOptions
+ThreadPoolOptions
+WorkerChoiceStrategyOptions
+WorkerNode
+WorkerOptions
+WorkerStatistics
+WorkerUsage
+Draft
+ErrorHandler
+ExitHandler
+KillBehavior
+Measurement
+MessageHandler
+OnlineHandler
+PoolEvent
+PoolType
+TaskFunctions
+ThreadWorkerWithMessageChannel
+WorkerAsyncFunction
+WorkerChoiceStrategy
+WorkerFunction
+WorkerSyncFunction
+WorkerType
+KillBehaviors
+Measurements
+PoolEvents
+PoolTypes
+WorkerChoiceStrategies
+WorkerTypes
Contract definition for a poolifier pool.
-