X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=c0fd81a3f099ace99c34bff7a71c4692e715b3aa;hb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;hp=d87f0c3d2043b7f61bd382241eb28b24562e95a4;hpb=13aa72e5091fcfe52dcd2acf1039091e1d55ea32;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index d87f0c3d..c0fd81a3 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,112 +1,116 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    -
    +
    +

    Hierarchy

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • - +

    Properties

    -
    choose -remove -requiredStatistics -reset -setOptions +
    choose +remove +reset +setOptions +strategyPolicy +taskStatisticsRequirements +update

    Properties

    -
    -

    choose

    -
    choose: (() => number)
    +
    +

    Readonly choose

    +
    choose: (() => undefined | number)

    Type declaration

    • -
        -
      • (): number
        • +
          +
        • (): undefined | number
        • -

          Chooses a worker node in the pool and returns its key.

          +

          Chooses a worker node in the pool and returns its key. +If the worker node is not eligible, undefined is returned.

          -

          Returns number

    -
    -

    remove

    -
    remove: ((workerNodeKey: number) => boolean)
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:195
    • +
    +

    Readonly remove

    +
    remove: ((workerNodeKey) => boolean)

    Type declaration

    • -
        -
      • (workerNodeKey: number): boolean
        • +
          +
        • (workerNodeKey): boolean
        • -

          Removes a worker node key from strategy internals.

          +

          Removes the worker node key from strategy internals.

          Parameters

          • -
            workerNodeKey: number
            +
            workerNodeKey: number

            The worker node key.

            -
          -

          Returns boolean

    -
    -

    Readonly requiredStatistics

    -
    requiredStatistics: RequiredStatistics
    -

    Required tasks usage statistics.

    -
    -
    -

    reset

    -
    reset: (() => boolean)
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:202
    • +
    +

    Readonly reset

    +
    reset: (() => boolean)

    Type declaration

    • -
        +
        • (): boolean
        • -

          Resets strategy internals (counters, statistics, etc.).

          +

          Resets strategy internals.

          -

          Returns boolean

    -
    -

    setOptions

    -
    setOptions: ((opts: WorkerChoiceStrategyOptions) => void)
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
    • +
    +

    Readonly setOptions

    +
    setOptions: ((opts) => void)

    Type declaration

    -

    Returns void

    +
    +

    Readonly strategyPolicy

    +
    strategyPolicy: StrategyPolicy
    +

    Strategy policy.

    +
    +
    +
    +

    Readonly taskStatisticsRequirements

    +
    taskStatisticsRequirements: TaskStatisticsRequirements
    +

    Tasks statistics requirements.

    +
    +
    +
    +

    Readonly update

    +
    update: ((workerNodeKey) => boolean)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (workerNodeKey): boolean
        • +
      • +

        Updates the worker node key strategy internals.

        +
        +
        +

        Parameters

        +
          +
        • +
          workerNodeKey: number
        +

        Returns boolean

        true if the update is successful, false otherwise.

        + +
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
    • -

    Settings

     +

    Settings

    Member Visibility

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

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • choose
    • +
  • remove
    • +
  • reset
    • +
  • setOptions
    • +
  • strategyPolicy
    • +
  • taskStatisticsRequirements
    • +
  • update
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file