X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=03db1e524310dbb0b4859f28fb7c54ca571c548a;hb=353260e334c7f801b1236890f3a0cb8a98ed2b8e;hp=5c308a437aecce0cd9e22980d635cf9c6fb91d7a;hpb=f63918da6f3fc77cc7f98e4d43e3f37955140468;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 5c308a43..03db1e52 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier
-
+
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:96
    • +

    remove

    -
    remove: ((workerNodeKey: number) => boolean)
    +
    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

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

    Readonly requiredStatistics

    -
    requiredStatistics: RequiredStatistics
    +
    requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

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

    reset

    -
    reset: (() => boolean)
    +
    reset: (() => boolean)

    Type declaration

    • -
        +
        • (): boolean
        • -

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

          +

          Resets strategy internals.

          -

          Returns boolean

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

    setOptions

    -
    setOptions: ((opts: WorkerChoiceStrategyOptions) => void)
    +
    setOptions: ((opts) => void)

    Type declaration

    Returns void

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

    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.

        +
    @@ -134,57 +159,63 @@
    • -

    Theme

    +

    Theme

    On This Page
    +
  • choose
    • +
  • remove
    • +
  • requiredStatistics
    • +
  • reset
    • +
  • setOptions
    • +
  • update
    • +
  • PoolType
    • +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MessageValue
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • RequiredStatistics
    • +
  • Task
    • +
  • TasksQueueOptions
    • +
  • TasksUsage
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • Draft
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • TaskFunctions
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • KillBehaviors
    • +
  • PoolEvents
    • +
  • WorkerChoiceStrategies

    • Generated using TypeDoc

    \ No newline at end of file