X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=a110781d33232d37523deb6f7ca6e384f5410956;hb=4a3cf20442bd8e728f1834006cbe8e2f10fe772a;hp=6b71c35ee4dd49528c5569ccf12497bc61c4d2ab;hpb=323daa7f98fd16385379e4b6e8def0a9a3f140c8;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 6b71c35e..a110781d 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,13 +1,13 @@ -WorkerChoiceStrategyContext | poolifier - v2.6.36
+WorkerChoiceStrategyContext | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    @@ -42,26 +42,26 @@
    • WorkerChoiceStrategyContext
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    choiceRetriesCount -opts +
    opts +retriesCount workerChoiceStrategies workerChoiceStrategy

    Methods

    -
    execute +
    execute getStrategyPolicy getTaskStatisticsRequirements remove @@ -72,7 +72,7 @@

    Constructors

    -

    constructor

    +

    constructor

    • @@ -93,29 +93,24 @@
    • pool: IPool<Worker, Data, Response>

      The pool instance.

      -
      • +
    +
  • workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    -
    • +
    +
  • opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

    The worker choice strategy options.

    -
    • +
    +

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:49

    • Properties

    -
    -

    Private choiceRetriesCount

    -
    choiceRetriesCount: number = 0
    -

    The number of times the worker choice strategy in the context has been retried.

    -
    -

    Private opts

    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
    @@ -123,12 +118,20 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52
    • +
    +

    Private retriesCount

    +
    retriesCount: number = 0
    +

    The number of times the worker choice strategy in the context has been retried.

    +
    +

    Private Readonly workerChoiceStrategies

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:32

    • Private workerChoiceStrategy

    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
    @@ -136,7 +139,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:51

    • Methods

    @@ -152,7 +155,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If after configured retries the worker node key is null or undefined .

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:173

    • getStrategyPolicy

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119

    • getTaskStatisticsRequirements

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132

    • remove

    + +

    Returns boolean

    true if the removal is successful, false otherwise.

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200

    • setOptions

    + +

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213

    • setWorkerChoiceStrategy

    + +

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:145

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:159
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -269,8 +275,8 @@
    -
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file