X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=f82f1fc3b8045fa92161f421312a9d7a19dec614;hb=41e3e08eb7fbcde0a69cea17e697aacb222990a6;hp=b8d02a3b8d2306644cd511e74b60732eaf82652f;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b8d02a3b..3ea66d2b 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,13 @@ -FixedThreadPool | poolifier

@@ -17,8 +17,6 @@

Class FixedThreadPool<Data, Response>

A thread pool with a fixed number of threads.

It is possible to perform tasks in sync or asynchronous mode as you prefer.

This pool selects the threads in a round robin fashion.

Author

Alessandro Pio Ardizio

@@ -30,37 +28,38 @@

Data = unknown
-
Type of data sent to the worker. This can only be serializable data.
+
Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-
Type of execution response. This can only be serializable data.
+
Type of execution response. This can only be structured-cloneable data.

Hierarchy

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

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

Index

Constructors

constructor

new FixedThreadPool<Data, Response>(numberOfThreads, filePath, opts?): FixedThreadPool<Data, Response>
@@ -129,7 +138,7 @@

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

opts: ThreadPoolOptions = {}

Options for this fixed thread pool.

@@ -137,7 +146,7 @@

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

Properties

@@ -146,16 +155,19 @@

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.
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.
'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).

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

`Protected` `Readonly` filePath

filePath: string

@@ -164,7 +176,16 @@

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

`Protected` `Optional` `Readonly` max

max?: number

Dynamic pool maximum size property placeholder.

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -173,20 +194,20 @@

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

`Protected` `Readonly` opts

opts: PoolOptions<ThreadWorkerWithMessageChannel>

Options for the pool.

opts: ThreadPoolOptions = {}

Options for this fixed thread pool.

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

`Protected` promiseResponseMap

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

The execution response promise map.

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

The task execution response promise map:

key: The message id of each submitted task.
value: An object that contains the worker, the execution response promise resolve and reject callbacks.

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, 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:83

`Readonly` workerNodes

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

`Readonly` `Internal` workerNodes

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

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

Accessors

@@ -230,7 +250,7 @@

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

`Protected` full

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

info

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

`Protected` maxSize

get maxSize(): number
-
Pool maximum size.
+
The pool maximum size.

Returns number
-
Overrides AbstractPool.maxSize
+
Inherited from AbstractPool.maxSize
- Defined in src/pools/thread/fixed.ts:115

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

`Protected` minSize

get minSize(): number
-
Pool minimum size.
+
The pool minimum size.

Returns number
-
Overrides AbstractPool.minSize
+
Inherited from AbstractPool.minSize
- Defined in src/pools/thread/fixed.ts:110

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

`Private` ready

get ready(): boolean
+
The pool readiness boolean status.
+
+
Returns boolean
+
+
Inherited from AbstractPool.ready
+
- Defined in src/pools/abstract-pool.ts:500

`Protected` type

get type(): "fixed" | "dynamic"
-
Pool type.
+
The pool type.

If it is 'dynamic', it provides the max property.

Returns "fixed" | "dynamic"
Overrides AbstractPool.type
- Defined in src/pools/thread/fixed.ts:100

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

`Private` utilization

get utilization(): number
+
The approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
Inherited from AbstractPool.utilization
+
- Defined in src/pools/abstract-pool.ts:517

`Protected` worker

get worker(): "cluster" | "thread"
get worker(): "thread" | "cluster"
-
Gets the worker type.
+
The worker type.

-
Returns "cluster" | "thread"
+
Returns "thread" | "cluster"
Overrides AbstractPool.worker
- Defined in src/pools/thread/fixed.ts:105

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

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker, message): void
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution. Can be overridden.
@@ -319,12 +364,12 @@ Can be overridden.

Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
- -
  message: MessageValue<Response, Worker | MessagePort>
  +
  message: MessageValue<Response, unknown>
  
  The received message.
@@ -332,32 +377,32 @@ Can be overridden.
Inherited from AbstractPool.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:464

`Protected` afterWorkerSetup

afterWorkerSetup(worker): void
Defined in src/pools/abstract-pool.ts:935

`Protected` afterWorkerNodeSetup

afterWorkerNodeSetup(workerNodeKey): void
-
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.
+
Method hooked up after a worker node has been newly created. +Can be overridden.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The newly created worker.
  +
  workerNodeKey: number
  +
  The newly created worker node key.
Returns void
-
Overrides AbstractPool.afterWorkerSetup
+
Inherited from AbstractPool.afterWorkerNodeSetup
- Defined in src/pools/thread/fixed.ts:90

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

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution. Can be overridden.
@@ -369,112 +414,133 @@ Can be overridden.

workerNodeKey: number

The worker node key.

+
+
task: Task<Data>
+
The task to execute.
+

Returns void

`Protected` chooseWorkerNode

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

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
Inherited from AbstractPool.checkDynamicPoolSize
+
- Defined in src/pools/abstract-pool.ts:187

`Protected` createAndSetupDynamicWorkerNode

chooseWorkerNode(): number
createAndSetupDynamicWorkerNode(): number
-
Chooses a worker node for the next task.
-
The default worker choice strategy uses a round robin algorithm to distribute the load.
+
Creates a new, completely set up dynamic worker node.

-
Returns number
The worker node key
+
Returns number
New, completely set up dynamic worker node key.
-
Inherited from AbstractPool.chooseWorkerNode
+
Inherited from AbstractPool.createAndSetupDynamicWorkerNode
- Defined in src/pools/abstract-pool.ts:532

`Protected` createAndSetupWorker

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

`Protected` createAndSetupWorkerNode

createAndSetupWorker(): ThreadWorkerWithMessageChannel
createAndSetupWorkerNode(): number
-
Creates a new worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up worker node.

-
Returns ThreadWorkerWithMessageChannel
New, completely set up worker.
+
Returns number
New, completely set up worker node key.
-
Inherited from AbstractPool.createAndSetupWorker
+
Inherited from AbstractPool.createAndSetupWorkerNode
- Defined in src/pools/abstract-pool.ts:596

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

`Protected` createWorker

createWorker(): ThreadWorkerWithMessageChannel
createWorker(): Worker
-
Returns a newly created worker.
+
Creates a new worker.

-
Returns ThreadWorkerWithMessageChannel
+
Returns Worker
Newly created worker.
+
Overrides AbstractPool.createWorker
- Defined in src/pools/thread/fixed.ts:83

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

destroy

destroy(): Promise<void>
-
Shutdowns every current worker in this pool.
+
Terminates all workers in this pool.

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

`Protected` destroyWorker

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

`Protected` destroyWorkerNode

destroyWorker(worker): Promise<void>
destroyWorkerNode(workerNodeKey): Promise<void>
-
Shutdowns the given worker.
+
Terminates the worker node given its worker node key.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  -
  A worker within workerNodes.
  +
  workerNodeKey: number
  +
  The worker node key.
Returns Promise<void>
-
Overrides AbstractPool.destroyWorker
+
Overrides AbstractPool.destroyWorkerNode
- Defined in src/pools/thread/fixed.ts:59

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

enableTasksQueue

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

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

execute

execute(data?, name?): Promise<Response>
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.

@@ -483,12 +549,17 @@ Can be overridden.
- Optional data: Data
  -
  The task input data for the specified worker function. This can only be serializable data.
  +
  The optional task input data for the specified task function. This can only be structured-cloneable data.
- Optional name: string
  -
  The name of the worker function to execute. If not specified, the default worker function will be executed.
  +
  The optional name of the task function to execute. If not specified, the default task function will be executed.
  +
  +
- +
  Optional transferList: TransferListItem[]
  +
  An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
@@ -496,16 +567,76 @@ Can be overridden.
Inherited from AbstractPool.execute
- Defined in src/pools/abstract-pool.ts:380

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

`Protected` flushTasksQueue

flushTasksQueue(workerNodeKey): void
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns void
+
Inherited from AbstractPool.flushTasksQueue
+
- Defined in src/pools/abstract-pool.ts:1542

`Protected` getWorkerInfo

getWorkerInfo(workerNodeKey): WorkerInfo
+
Gets the worker information given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Inherited from AbstractPool.getWorkerInfo
+
- Defined in src/pools/abstract-pool.ts:1458

hasWorkerNodeBackPressure

hasWorkerNodeBackPressure(workerNodeKey): boolean
Internal +
Whether the worker node has back pressure (i.e. its tasks queue is full).
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns boolean
true if the worker node has back pressure, false otherwise.
+ +
+
Inherited from AbstractPool.hasWorkerNodeBackPressure
+
- Defined in src/pools/abstract-pool.ts:1500

`Protected` internalBusy

internalBusy(): boolean
-
Returns boolean
+
Whether worker nodes are executing concurrently their tasks quota or not.
+
+
Returns boolean
Worker nodes busyness boolean status.
+ +
Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:371

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

`Protected` isMain

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

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of task function available in this pool.
+
+
Returns string[]
The names of task function available in this pool.
+ +
+
Inherited from AbstractPool.listTaskFunctions
+
- Defined in src/pools/abstract-pool.ts:758

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
-
Registers a listener callback on the given worker.
+
Registers a listener callback on the worker given its worker node key.
Type Parameters
@@ -534,8 +678,8 @@ Can be overridden.

Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The worker which should register a listener.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -552,58 +696,99 @@ Can be overridden.
  
  Parameters
  - -
    message: MessageValue<Message, Worker | MessagePort>
+
message: MessageValue<Message, unknown>

Returns void

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

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+
+
Parameters
+
- +
  workerNodeKey: number
- +
  workerId: number
+
Returns Promise<void>
+
Inherited from AbstractPool.sendKillMessageToWorker
+
- Defined in src/pools/abstract-pool.ts:860

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(workerNodeKey): void
+
Sends the startup message to worker given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns void
+
+
Overrides AbstractPool.sendStartupMessageToWorker
+
- Defined in src/pools/thread/fixed.ts:91

`Protected` sendToWorker

sendToWorker(worker, message): void
sendToWorker(workerNodeKey, message, transferList?): void
-
Sends a message to the given worker.
+
Sends a message to worker given its worker node key.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The worker which should receive the message.
  +
  workerNodeKey: number
  +
  The worker node key.
- -
  message: MessageValue<Data, Worker | MessagePort>
  +
  message: MessageValue<Data, unknown>
  
  The message.
  
  +
- +
  Optional transferList: TransferListItem[]
  +
  The optional array of transferable objects.
  +
Returns void
Overrides AbstractPool.sendToWorker
- Defined in src/pools/thread/fixed.ts:67

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

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions): void
-
Sets the worker tasks queue options in this pool.
+
Sets the worker node tasks queue options in this pool.
Parameters
- tasksQueueOptions: TasksQueueOptions
  -
  The worker tasks queue options.
  +
  The worker node tasks queue options.
Returns void
Inherited from AbstractPool.setTasksQueueOptions
- Defined in src/pools/abstract-pool.ts:337

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

setWorkerChoiceStrategy

Parameters

-
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

The worker choice strategy.

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

setupHook(): void
-
Setup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+
Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.

Returns void
Inherited from AbstractPool.setupHook
- Defined in src/pools/abstract-pool.ts:438

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

start

start(): void
+
Starts the minimum number of workers in this pool.
+
+
Returns void
+
+
Inherited from AbstractPool.start
+
- Defined in src/pools/abstract-pool.ts:834

`Protected` workerListener

workerListener(): ((message) => void)
-
This function is the listener registered for each worker message.
+
This method is the listener registered for each worker message.

Returns ((message) => void)
The listener function to execute when a message is received from a worker.
@@ -676,33 +873,33 @@ Can be overridden
- (message): void
- -
  This function is the listener registered for each worker message.
  +
  This method is the listener registered for each worker message.
  Parameters
  
  -
  message: MessageValue<Response, Worker | MessagePort>
  +
  message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.

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

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file

Class FixedThreadPool<Data, Response>

Author

Data = unknown

Response = unknown

Hierarchy

Index

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

constructor

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

opts: ThreadPoolOptions = {}

Properties

Protected Readonly filePath

Protected Optional Readonly max

Protected Readonly numberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Protected workerChoiceStrategyContext

Readonly workerNodes

Readonly Internal workerNodes

Accessors

Protected full

info

Protected maxSize

Returns number

Protected minSize

Returns number

Private ready

Returns boolean

Protected type

Returns "fixed" | "dynamic"

Private utilization

Returns number

Protected worker

Returns "cluster" | "thread"

Returns "thread" | "cluster"

Methods

Protected afterTaskExecutionHook

Parameters

worker: ThreadWorkerWithMessageChannel

workerNodeKey: number

message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, unknown>

Protected afterWorkerSetup

Protected afterWorkerNodeSetup

Parameters

worker: ThreadWorkerWithMessageChannel

workerNodeKey: number

Returns void

Protected beforeTaskExecutionHook

workerNodeKey: number

task: Task<Data>

Returns void

Protected chooseWorkerNode

Protected checkDynamicPoolSize

Parameters

min: number

max: number

Returns void

Protected createAndSetupDynamicWorkerNode

Returns number

Returns number

Protected createAndSetupWorker

Protected createAndSetupWorkerNode

Returns ThreadWorkerWithMessageChannel

Returns number

Protected createWorker

Returns ThreadWorkerWithMessageChannel

Returns Worker

destroy

Returns Promise<void>

Protected destroyWorker

Protected destroyWorkerNode

Parameters

worker: ThreadWorkerWithMessageChannel

`Protected` `Readonly` filePath

`Protected` `Optional` `Readonly` max

`Protected` `Readonly` numberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Protected` workerChoiceStrategyContext

`Readonly` workerNodes

`Readonly` `Internal` workerNodes

`Protected` full

`Protected` maxSize

`Protected` minSize

`Private` ready

`Protected` type

`Private` utilization

`Protected` worker

`Protected` afterTaskExecutionHook

`Protected` afterWorkerSetup

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Protected` chooseWorkerNode

`Protected` checkDynamicPoolSize

`Protected` createAndSetupDynamicWorkerNode

`Protected` createAndSetupWorker

`Protected` createAndSetupWorkerNode

`Protected` createWorker

`Protected` destroyWorker

`Protected` destroyWorkerNode

`Optional` tasksQueueOptions: TasksQueueOptions

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Protected` flushTasksQueue

`Protected` getWorkerInfo

`Protected` internalBusy

`Protected` isMain

`Protected` registerWorkerMessageListener

`Protected` sendKillMessageToWorker

`Protected` sendStartupMessageToWorker

`Protected` sendToWorker

`Optional` transferList: TransferListItem[]

`Protected` setupHook