X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=68054436202d8c229a0520001aeaa2722eec5814;hb=603ce450e1c02a53a06aff9e9ba5f3cdee24a3f2;hp=2fe3ca962cfc71ff20bf1b4ca1e2e09623541bb7;hpb=5dd39e0fba309bb3af0ca64aea5205f57dfe5d24;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 2fe3ca96..68054436 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.34
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.34
    @@ -14,16 +14,17 @@ -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    -
    + +

    Hierarchy

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • @@ -31,33 +32,36 @@

    Properties

    -
    choose -remove -requiredStatistics -reset -setOptions -update +
    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

        The worker node key.

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

    remove

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

    @@ -74,20 +78,15 @@
  • workerNodeKey: number

    The worker node key.

    -
    • + +

    Returns boolean

    true if the worker node key is removed, false otherwise.

    -
    -
    -

    Readonly requiredStatistics

    -
    requiredStatistics: RequiredStatistics
    -

    Required tasks usage statistics.

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

    reset

    +

    Readonly reset

    reset: (() => boolean)

    Type declaration

    @@ -99,11 +98,12 @@

    Resets strategy internals.

    Returns boolean

    true if the reset is successful, false otherwise.

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

    setOptions

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

    @@ -120,12 +120,30 @@
  • opts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    • -

    Returns void

    +
    +

    Readonly strategyPolicy

    +
    strategyPolicy: StrategyPolicy
    +

    Strategy policy.

    +
    +
    +
    +

    Readonly taskStatisticsRequirements

    +
    taskStatisticsRequirements: TaskStatisticsRequirements
    +

    Tasks statistics requirements.

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

    update

    +

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

    @@ -142,14 +160,15 @@
  • 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

    @@ -161,61 +180,80 @@

    Theme

    -

    On This Page

     +

    On This Page

    +
  • choose
    • +
  • remove
    • +
  • reset
    • +
  • setOptions
    • +
  • strategyPolicy
    • +
  • taskStatisticsRequirements
    • +
  • update
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • Deque
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • EventLoopUtilizationMeasurementStatistics
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • IWorkerNode
    • +
  • MeasurementOptions
    • +
  • MeasurementStatistics
    • +
  • MeasurementStatisticsRequirements
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • StrategyPolicy
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerInfo
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • KillHandler
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskAsyncFunction
    • +
  • TaskFunction
    • +
  • TaskFunctions
    • +
  • TaskSyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerType
    • +
  • Writable
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file