X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=9cdf6715e534514d16cd3a3e93c0d2efd7a1be93;hb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;hp=e393f5cbc6d899624d14bb4a81c6b8380de01516;hpb=f63918da6f3fc77cc7f98e4d43e3f37955140468;p=poolifier.git
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index e393f5cb..9cdf6715 100644
--- a/docs/classes/WorkerChoiceStrategyContext.html
+++ b/docs/classes/WorkerChoiceStrategyContext.html
@@ -1,4 +1,4 @@
-
WorkerChoiceStrategyContext | poolifier
+WorkerChoiceStrategyContext | poolifier
@@ -17,28 +17,32 @@
Class WorkerChoiceStrategyContext<Worker, Data, Response>
-
+
+
Type Parameters
-
+
-
-
Worker extends IWorker
+Worker extends IWorker
+
+
-
-
Data = unknown
+Data = unknown
+
+
-
-
Response = unknown
+Response = unknown
+
+
Hierarchy
- WorkerChoiceStrategyContext
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:25
@@ -46,120 +50,129 @@
Constructors
-constructor
+
Properties
-workerChoiceStrategies
-
workerChoiceStrategy
+
Constructors
-
-constructor
-
-- new WorkerChoiceStrategyContext<Worker, Data, Response>(pool: IPool<Worker, Data, Response>, workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", opts?: WorkerChoiceStrategyOptions): WorkerChoiceStrategyContext<Worker, Data, Response>
+
+constructor
+
+- new WorkerChoiceStrategyContext<Worker, Data, Response>(pool, workerChoiceStrategy?, opts?): WorkerChoiceStrategyContext<Worker, Data, Response>
-
-
-
-
Data = unknown
+Data = unknown
-
-
Response = unknown
+Response = unknown
Parameters
-
-
pool: IPool<Worker, Data, Response>
+pool: IPool<Worker, Data, Response>
+
+
-workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
+
+
-
+
-
+
+
+
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:42
Properties
-
-Private
Readonly
workerChoiceStrategies
-worker
Choice
Strategies
: Map<"ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
+
+Private
workerChoiceStrategy
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:44
Methods
-
-execute
-
-- execute(): number
+
+execute
+
+- execute(): number
-
-
Returns number
-
+
-
+
+remove
+
+- remove(workerNodeKey): boolean
-
-
+
+Returns boolean
true
if the removal is successful, false
otherwise.
+
+
-
+
+setOptions
+
+- setOptions(opts): void
-
@@ -167,16 +180,18 @@
Parameters
-Returns void
+Returns void
+
-
-setWorkerChoiceStrategy
-
+
+setWorkerChoiceStrategy
+
+- setWorkerChoiceStrategy(workerChoiceStrategy): void
-
@@ -184,17 +199,36 @@
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
+Returns void
+
+
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:131
-On This Page
+On This Page
+constructor
+workerChoiceStrategies
+workerChoiceStrategy
+execute
+getRequiredStatistics
+remove
+setOptions
+setWorkerChoiceStrategy
+update
+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
The worker choice strategy context.
-