X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=a5f77512354de354d56ca7aaef2ae8b056d194af;hb=5decbf239157d04bdf38a642fe2757f565a8d466;hp=bef39e3847e3106f8a001d2f57afe019e5cff9f1;hpb=bb3f9b66fa2241864d31937eeced22caab83d17e;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index bef39e38..a5f77512 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier
+FixedThreadPool | poolifier
-
+

Type Parameters

-
    +
    • -

      Data = unknown

      +

      Data = unknown

      Type of data sent to the worker. This can only be serializable data.

    • -

      Response = unknown

      -

      Type of response of execution. This can only be serializable data.

      +

      Response = unknown

      +

      Type of execution response. This can only be serializable data.

Hierarchy

+
  • Defined in src/pools/thread/fixed.ts:34
  • @@ -52,118 +52,129 @@

    Constructors

    -
    +
    -
      - +
        +
      • Constructs a new poolifier fixed thread pool.

        -
        +

        Type Parameters

        -
          +
          • -

            Data = unknown

          • +

            Data = unknown

          • -

            Response = unknown

        +

        Response = unknown

    Parameters

    -

    Returns FixedThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/fixed.ts:45
  • Properties

    -
    +
    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    -
    - -
    filePath: string
    -

    Path to the worker-file.

    +
    emitter?: PoolEmitter
    +

    Emitter on which events can be listened to.

    +

    Events that can currently be listened to:

    +
      +
    • 'full': Emitted when the pool is dynamic and full.
    • +
    • 'busy': Emitted when the pool is busy.
    • +
    • 'error': Emitted when an uncaught error occurs.
    • +
    • 'taskError': Emitted when an error occurs while executing a task.
    • +
    +
    +
    + +
    filePath: string
    +

    Path to the worker file.

    -
    - -
    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:82
  • +
    + +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    -
    - - +
  • Defined in src/pools/abstract-pool.ts:81
  • +
    + +

    Options for the pool.

    -
    +
  • Defined in src/pools/abstract-pool.ts:83
  • +
    -
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...

    The execution response promise map.

    • key: The message id of each submitted task.
    • @@ -171,89 +182,114 @@

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -
    +
  • Defined in src/pools/abstract-pool.ts:57
  • +
    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    Default to a round robin algorithm.

    -
    +
  • Defined in src/pools/abstract-pool.ts:67
  • +
    -
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    -
    -

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:44
  • Accessors

    -
    - -
    +
    + +
    • get full(): boolean
    • -
      -

      Inherit Doc

      +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +

      Returns boolean

    -
    - -
    +
    + +
    +
    + +
      +
    • get maxSize(): number
    • -

      Number of tasks queued in the pool.

      +

      Pool maximum size.

      Returns number

    -
    - -
    +
    + +
      +
    • get minSize(): number
    • -

      Number of tasks running in the pool.

      +

      Pool minimum size.

      Returns number

    -
    - -
    +
    + +
      +
    • get type(): "fixed" | "dynamic"
    • -
      -

      Inherit Doc

      -

      Returns PoolType

    +
  • Defined in src/pools/thread/fixed.ts:100
  • +
    + +
      +
    • get worker(): "cluster" | "thread"
    • +
    • +

      Gets the worker type.

      +
      +

      Returns "cluster" | "thread"

    Methods

    -
    +
    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:464
  • +
    -
      - +
        +
      • -
        -

        Inherit Doc

        +

        Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.

        +

        Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.

        +

        Parameters

        +
        worker: ThreadWorkerWithMessageChannel
        +

        The newly created worker.

        +

    Returns void

    -
    +
  • Defined in src/pools/thread/fixed.ts:90
  • +
    -
      - +
        +
      • Hook executed before the worker task execution. Can be overridden.

        @@ -301,233 +340,299 @@ Can be overridden.

        Parameters

        • -
          workerNodeKey: number
          +
          workerNodeKey: number

          The worker node key.

        Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:453
  • +
    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:532
  • +
    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:596
  • +
    -
    -
    +
  • Defined in src/pools/thread/fixed.ts:83
  • +
    -
      - +
    -
    - -
    +
    + +
    +
    + +
      + +
    • +

      Enables/disables the worker tasks queue in this pool.

      +

      Parameters

      -

      Returns Promise<void>

    • +
    • +
      Optional tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +
    +

    Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:325
  • +
    -
      - +
        +
      • -
        -

        Inherit Doc

        +

        Executes the specified function in the worker constructor with the task data input parameter.

        +

        Parameters

        • -
          data: Data
        -

        Returns Promise<Response>

    -
    - -
      - -
    • -
      -

      Inherit Doc

      -

      Returns number

    • +
    • +
      Optional name: string
      +

      The name of the worker function to execute. If not specified, the default worker function will be executed.

      +
    +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
    -
    +
  • Defined in src/pools/abstract-pool.ts:380
  • +
    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:371
  • +
    -
      - +
    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      -
      +

      Registers a listener callback on the given worker.

      +
      +

      Type Parameters

      -
        +
        • -

          Message

      +

      Message

    Parameters

    • -
      messageChannel: ThreadWorkerWithMessageChannel
    • +
      worker: ThreadWorkerWithMessageChannel
      +

      The worker which should register a listener.

      +
    • -
      listener: ((message: MessageValue<Message, unknown>) => void)
      +
      listener: ((message) => void)
      +

      The message listener callback.

      +
      • -
          -
        • (message: MessageValue<Message, unknown>): void
        • +
            +
          • (message): void
          • Parameters

            • -
              message: MessageValue<Message, unknown>
            +
            message: MessageValue<Message, Worker | MessagePort>

    Returns void

    Returns void

    -
    +
  • Defined in src/pools/thread/fixed.ts:75
  • +
    -
    +
    + +
      + +
    • +

      Sets the worker tasks queue options in this pool.

      +
      +
      +

      Parameters

      +
      • -
        message: MessageValue<Data, unknown>
      +
      tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +

    Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:337
  • +
    -
      - +
        +
      • -
        -

        Inherit Doc

        +

        Sets the worker choice strategy in this pool.

        +

        Parameters

        • -
          workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
        +
        workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        +

        The worker choice strategy.

        +
      • +
      • +
        Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
        +

        The worker choice strategy options.

        +

      Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:284
  • +
    + +
    +
    -
      - +
        +
      • Setup hook to execute code before worker node are created in the abstract constructor. Can be overridden

        Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:438
  • +
    -
      - +
        +
      • This function is the listener registered for each worker message.

        - -

        Returns

        The listener function to execute when a message is received from a worker.

        -

        Returns ((message: MessageValue<Response, unknown>) => void)

        +

        Returns ((message) => void)

        The listener function to execute when a message is received from a worker.

        +
        • -
            -
          • (message: MessageValue<Response, unknown>): void
          • +
              +
            • (message): void
            • This function is the listener registered for each worker message.

              - -

              Returns

              The listener function to execute when a message is received from a worker.

              Parameters

              • -
                message: MessageValue<Response, unknown>
              -

              Returns void

        +

        Returns void

        The listener function to execute when a message is received from a worker.

        +
    +
  • Defined in src/pools/abstract-pool.ts:629
  • +

    Theme

    On This Page

    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • info
  • +
  • maxSize
  • +
  • minSize
  • +
  • type
  • +
  • worker
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • chooseWorkerNode
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • enableTasksQueue
  • +
  • execute
  • +
  • internalBusy
  • +
  • isMain
  • +
  • registerWorkerMessageListener
  • +
  • sendToWorker
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • setupHook
  • +
  • workerListener
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • RequiredStatistics
  • +
  • Task
  • +
  • TasksQueueOptions
  • +
  • TasksUsage
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • Draft
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • ThreadWorkerWithMessageChannel
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • Generated using TypeDoc

    \ No newline at end of file