X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FWorkerChoiceStrategyContext.html;h=a110781d33232d37523deb6f7ca6e384f5410956;hb=b6fea09e6a8174e664770741943cf08445066e2b;hp=5e541fc8a8158197a294374ef14de034d00bef1d;hpb=afa30fd0dd5bbc5d305cc30be663966a449efc08;p=poolifier.git diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 5e541fc8..a110781d 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,13 +1,13 @@ -WorkerChoiceStrategyContext | poolifier
+WorkerChoiceStrategyContext | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    @@ -29,12 +29,12 @@

  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    -

    Type of execution response. This can only be serializable data.

    +

    Type of execution response. This can only be structured-cloneable data.

    • @@ -42,25 +42,28 @@
    • WorkerChoiceStrategyContext
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    workerChoiceStrategies +
    opts +retriesCount +workerChoiceStrategies workerChoiceStrategy

    Methods

    -
    execute -getTaskStatistics +
    execute +getStrategyPolicy +getTaskStatisticsRequirements remove setOptions setWorkerChoiceStrategy @@ -69,7 +72,7 @@

    Constructors

    -

    constructor

    +

    constructor

    • @@ -79,7 +82,7 @@

      Type Parameters

      • -

        Worker extends IWorker<Worker>

        • +

        Worker extends IWorker

      • Data = unknown

      • @@ -93,7 +96,7 @@
  • -
    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
    +
    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.

    • @@ -105,22 +108,38 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    • Properties

    +
    +

    Private opts

    +
    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
    +

    The worker choice strategy options.

    +
    +
    +
    +

    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" | "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" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
    +
    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.

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

    • Methods

    @@ -128,27 +147,39 @@
    -
    -

    getTaskStatistics

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

    getStrategyPolicy

    +
    +
    +

    getTaskStatisticsRequirements

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

    • remove

      @@ -161,14 +192,14 @@
      • workerNodeKey: number
        -

        The key of the worker node.

        +

        The worker node key.

    Returns boolean

    true if the removal is successful, false otherwise.

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

    • setOptions

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

    • setWorkerChoiceStrategy

      @@ -199,20 +230,20 @@

      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"

        The worker choice strategy to set.

    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

    @@ -244,64 +275,42 @@
    -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file