Interface WorkerChoiceStrategiesContext<Worker, Data, Response>Internal

retriesCount

execute

• execute(
      workerChoiceStrategy?:
          | "FAIR_SHARE"
          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
          | "LEAST_BUSY"
          | "LEAST_ELU"
          | "LEAST_USED"
          | "ROUND_ROBIN"
          | "WEIGHTED_ROUND_ROBIN",
  ): number

  Executes the given worker choice strategy in the context algorithm.

  Parameters

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

    The worker choice strategy algorithm to execute.

  Returns number

  The key of the worker node.

  Default Value

  this.defaultWorkerChoiceStrategy
  Copy

  Throws

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

getPolicy

• getPolicy(): StrategyPolicy

  Gets the active worker choice strategies in the context policy.

  Returns StrategyPolicy

  The strategies policy.

getTaskStatisticsRequirements

• getTaskStatisticsRequirements(): TaskStatisticsRequirements

  Gets the active worker choice strategies in the context task statistics requirements.

  Returns TaskStatisticsRequirements

  The strategies task statistics requirements.

remove

• remove(workerNodeKey: number): boolean

  Removes the worker node key from the active worker choice strategies in the context.

  Parameters

  • workerNodeKey: number

    The worker node key.

  Returns boolean

  true if the removal is successful, false otherwise.

setDefaultWorkerChoiceStrategy

• setDefaultWorkerChoiceStrategy(
      workerChoiceStrategy:
          | "FAIR_SHARE"
          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
          | "LEAST_BUSY"
          | "LEAST_ELU"
          | "LEAST_USED"
          | "ROUND_ROBIN"
          | "WEIGHTED_ROUND_ROBIN",
      opts?: WorkerChoiceStrategyOptions,
  ): void

  Sets the default worker choice strategy to use in the context.

  Parameters

  • workerChoiceStrategy:
        | "FAIR_SHARE"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "LEAST_USED"
        | "ROUND_ROBIN"
        | "WEIGHTED_ROUND_ROBIN"

    The default worker choice strategy to set.
  • Optionalopts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

  Returns void

setOptions

• setOptions(opts: undefined | WorkerChoiceStrategyOptions): void

  Sets the active worker choice strategies in the context options.

  Parameters

  • opts: undefined | WorkerChoiceStrategyOptions

    The worker choice strategy options.

  Returns void

syncWorkerChoiceStrategies

• syncWorkerChoiceStrategies(
      workerChoiceStrategies: Set<
          | "FAIR_SHARE"
          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
          | "LEAST_BUSY"
          | "LEAST_ELU"
          | "LEAST_USED"
          | "ROUND_ROBIN"
          | "WEIGHTED_ROUND_ROBIN",
      >,
      opts?: WorkerChoiceStrategyOptions,
  ): void

  Synchronizes the active worker choice strategies in the context with the given worker choice strategies.

  Parameters

  • workerChoiceStrategies: Set<
        | "FAIR_SHARE"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "LEAST_USED"
        | "ROUND_ROBIN"
        | "WEIGHTED_ROUND_ROBIN",
    >

    The worker choice strategies to synchronize.
  • Optionalopts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

  Returns void

update

• update(workerNodeKey: number): boolean

  Updates the worker node key in the active worker choice strategies in the context internals.

  Parameters

  • workerNodeKey: number

    The worker node key.

  Returns boolean

  true if the update is successful, false otherwise.