FixedThreadPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=c4abb69c45cb8feb98782bb01e23852a146e78ca;hb=7d6b5ad23febf5c7830f98a10fb75fb29853bcdb;hp=a7b5b27c4ec19ee612dde0598367a1310d42d962;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a7b5b27c..c4abb69c 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier

+FixedThreadPool | poolifier

Response = unknown

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

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

Hierarchy

AbstractPool<ThreadWorkerWithMessageChannel, Data, Response> +
AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
- FixedThreadPool
  - DynamicThreadPool

Defined in src/pools/thread/fixed.ts:29

@@ -66,8 +66,8 @@

@@ -97,7 +100,7 @@

constructor

new FixedThreadPool<Data, Response>(numberOfThreads: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): FixedThreadPool<Data, Response>
new FixedThreadPool<Data, Response>(numberOfThreads: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): FixedThreadPool<Data, Response>
Constructs a new poolifier fixed thread pool.

@@ -123,47 +126,52 @@
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

Options for this fixed thread pool.

Returns FixedThreadPool<Data, Response>

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Inherit Doc

'full': Emitted when the pool is dynamic and full.

'busy': Emitted when the pool is busy.

+ +

`Readonly` filePath

filePath: string

Path to the worker-file.

Path to the worker file.

Defined in src/pools/abstract-pool.ts:77

`Readonly` numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

Defined in src/pools/abstract-pool.ts:76

`Readonly` opts

opts: PoolOptions<ThreadWorkerWithMessageChannel>

Options for the pool.

Defined in src/pools/abstract-pool.ts:78

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...

The execution response promise map.

key: The message id of each submitted task.

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:52

`Protected` workerChoiceStrategyContext

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:62

`Readonly` workerNodes

workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []

Inherit Doc

Defined in src/pools/abstract-pool.ts:39

Accessors

busy

`Protected` busy

get busy(): boolean
-
-
Inherit Doc
+
Whether the pool is busy or not.
+
The pool busyness boolean status.
+

Returns boolean
Overrides AbstractPool.busy
- Defined in src/pools/thread/fixed.ts:105

full

Defined in src/pools/thread/fixed.ts:105

`Protected` full

get full(): boolean
-
-
Inherit Doc
+
Whether the pool is full or not.
+
The pool filling boolean status.
+

Returns boolean
Overrides AbstractPool.full
- Defined in src/pools/thread/fixed.ts:100

Defined in src/pools/thread/fixed.ts:100

`Private` numberOfQueuedTasks

Returns number

Defined in src/pools/abstract-pool.ts:195

`Private` numberOfRunningTasks

Returns number

Defined in src/pools/abstract-pool.ts:185

type

get type(): PoolType
get type(): PoolType
-
-
Inherit Doc
-
Returns PoolType
+
Pool type.
+
If it is 'dynamic', it provides the max property.
+
+
Returns PoolType
Overrides AbstractPool.type
- Defined in src/pools/thread/fixed.ts:95

Defined in src/pools/thread/fixed.ts:95

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Response, unknown>): void
afterTaskExecutionHook(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Response, unknown>): void
Hook executed after the worker task execution. Can be overridden.
@@ -266,29 +277,32 @@ Can be overridden.

The worker.
-
message: MessageValue<Response, unknown>
+
message: MessageValue<Response, unknown>

The received message.

Returns void

Defined in src/pools/abstract-pool.ts:389

`Protected` afterWorkerSetup

afterWorkerSetup(worker: ThreadWorkerWithMessageChannel): void
-
-
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
+
worker: ThreadWorkerWithMessageChannel
+
The newly created worker.
+

Returns void

Defined in src/pools/thread/fixed.ts:85

`Protected` beforeTaskExecutionHook

The worker node key.

Returns void

Defined in src/pools/abstract-pool.ts:378

`Protected` chooseWorkerNode

chooseWorkerNode(): [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
chooseWorkerNode(): [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
Chooses a worker node for the next task.

The default uses a round robin algorithm to distribute the load.

Returns
[worker node key, worker node].

-
Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
-
Inherited from AbstractPool.chooseWorkerNode
+
Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
+
Inherited from AbstractPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:337

Defined in src/pools/abstract-pool.ts:422

`Protected` createAndSetupWorker

Returns

New, completely set up worker.

Returns ThreadWorkerWithMessageChannel

Defined in src/pools/abstract-pool.ts:484

`Protected` createWorker

createWorker(): ThreadWorkerWithMessageChannel
-
-
Inherit Doc
+
Returns a newly created worker.
+

Returns ThreadWorkerWithMessageChannel
-
Overrides AbstractPool.createWorker
+
Overrides AbstractPool.createWorker
- Defined in src/pools/thread/fixed.ts:78

Defined in src/pools/thread/fixed.ts:78

destroy

destroy(): Promise<void>
-
-
Inherit Doc
+
Shutdowns every current worker in this pool.
+

Returns Promise<void>
-
Inherited from AbstractPool.destroy
+
Inherited from AbstractPool.destroy
- Defined in src/pools/abstract-pool.ts:256

destroyWorker

Defined in src/pools/abstract-pool.ts:341

`Protected` destroyWorker

destroyWorker(worker: ThreadWorkerWithMessageChannel): Promise<void>
-
-
Inherit Doc
+
Shutdowns the given worker.
+
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
+
worker: ThreadWorkerWithMessageChannel
+
A worker within workerNodes.
+

Returns Promise<void>

Defined in src/pools/thread/fixed.ts:54

enableTasksQueue

enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
+
Enables/disables the worker tasks queue in this pool.
+
+
+
Parameters
+
- +
  enable: boolean
  +
  Whether to enable or disable the worker tasks queue.
  +
- +
  Optional tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
  +
+
Returns void
+
Inherited from AbstractPool.enableTasksQueue
+
- Defined in src/pools/abstract-pool.ts:254

execute

execute(data: Data): Promise<Response>
execute(data?: Data): Promise<Response>
-
-
Inherit Doc
+
Executes the function specified in the worker constructor with the task data input parameter.
+ +
Returns
Promise that will be fulfilled when the task is completed.
+
Parameters
- -
  data: Data
-
Returns Promise<Response>
-
Inherited from AbstractPool.execute
+
Optional data: Data
+
The task input data for the specified worker function. This can only be serializable data.
+

Returns Promise<Response>

Defined in src/pools/abstract-pool.ts:310

findFreeWorkerNodeKey

findFreeWorkerNodeKey(): number
-
-
Inherit Doc
+
Finds a free worker node key based on the number of tasks the worker has applied.
+
If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
+
If no free worker is found, -1 is returned.
+ +
Returns
A worker node key if there is one, -1 otherwise.
+

Returns number
-
Inherited from AbstractPool.findFreeWorkerNodeKey
+
Inherited from AbstractPool.findFreeWorkerNodeKey
- Defined in src/pools/abstract-pool.ts:221

Defined in src/pools/abstract-pool.ts:303

`Protected` internalBusy

internalBusy(): boolean
Returns boolean
-
Inherited from AbstractPool.internalBusy
+
Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:216

Defined in src/pools/abstract-pool.ts:298

`Protected` isMain

isMain(): boolean
-
-
Inherit Doc
+
Should return whether the worker is the main worker or not.
+

Returns boolean
-
Overrides AbstractPool.isMain
+
Overrides AbstractPool.isMain
- Defined in src/pools/thread/fixed.ts:49

registerWorkerMessageListener

registerWorkerMessageListener<Message>(messageChannel: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
Defined in src/pools/thread/fixed.ts:49

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
-
Inherit Doc
+
Registers a listener callback on the given worker.
+
Type Parameters
Returns void
-
Overrides AbstractPool.registerWorkerMessageListener
+
Overrides AbstractPool.registerWorkerMessageListener
- Defined in src/pools/thread/fixed.ts:70

Defined in src/pools/thread/fixed.ts:70

`Protected` sendToWorker

sendToWorker(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Data, unknown>): void
sendToWorker(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Data, unknown>): void
-
-
Inherit Doc
+
Sends a message to the given worker.
+
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
- +
  message: MessageValue<Data, unknown>
  +
  The message.
  +
+
Returns void
+
Overrides AbstractPool.sendToWorker
+
- Defined in src/pools/thread/fixed.ts:62

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
+
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:266

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
-
-
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" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+
The worker choice strategy.
+
+
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+
The worker choice strategy options.
+

Returns void

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions: WorkerChoiceStrategyOptions): void
+
Sets the worker choice strategy options in this pool.
+
+
+
Parameters
+
- +
  workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
  +
Returns void
-
Inherited from AbstractPool.setWorkerChoiceStrategy
+
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
- Defined in src/pools/abstract-pool.ts:189

Defined in src/pools/abstract-pool.ts:244

`Protected` setupHook

Returns void

Defined in src/pools/abstract-pool.ts:363

`Protected` workerListener

workerListener(): ((message: MessageValue<Response, unknown>) => void)
workerListener(): ((message: MessageValue<Response, unknown>) => 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.

-
Returns ((message: MessageValue<Response, unknown>) => void)
+
Returns ((message: MessageValue<Response, unknown>) => void)
- - (message: MessageValue<Response, unknown>): void
  - (message: MessageValue<Response, unknown>): void
  - This function is the listener registered for each worker message.
    @@ -523,15 +619,16 @@ Can be overridden
    
    Parameters
    - -
      message: MessageValue<Response, unknown>
    +
    message: MessageValue<Response, unknown>
  Returns void

- + - + +

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Inherit Doc

Returns boolean

worker: ThreadWorkerWithMessageChannel

worker: ThreadWorkerWithMessageChannel

enable: boolean

`Optional` tasksQueueOptions: TasksQueueOptions

data: Data

messageChannel: ThreadWorkerWithMessageChannel

worker: ThreadWorkerWithMessageChannel

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

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

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>

Returns void

worker: ThreadWorkerWithMessageChannel

message: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Member Visibility

Theme