X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=502316d6172ee7d7dff0ecd8ce71dc06241deb33;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=11d7386d79e90033ce8405289f86837bd4c10b7c;hpb=f8350486e75b15ed17249cda3d0a55ee807a6a9f;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 11d7386d..502316d6 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -14,16 +14,17 @@ -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    -
    + +

    Hierarchy

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:160
    • @@ -31,17 +32,18 @@

    Properties

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

    Properties

    -

    choose

    +

    Readonly choose

    choose: (() => number)

    Type declaration

    @@ -53,11 +55,12 @@

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

    Returns number

    The worker node key.

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

    remove

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

    @@ -74,20 +77,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:193
    • -

    reset

    +

    Readonly reset

    reset: (() => boolean)

    Type declaration

    @@ -99,11 +97,12 @@

    Resets strategy internals.

    Returns boolean

    true if the reset is successful, false otherwise.

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

    setOptions

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

    @@ -120,12 +119,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:168
    • -

    update

    +

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

    @@ -142,14 +159,15 @@
  • workerNodeKey: number

    • Returns boolean

    true if the update is successful, false otherwise.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -161,61 +179,79 @@

    Theme

    -

    On This Page

     +

    On This Page

    +
  • choose
    • +
  • remove
    • +
  • reset
    • +
  • setOptions
    • +
  • strategyPolicy
    • +
  • taskStatisticsRequirements
    • +
  • update
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • 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
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file