DynamicThreadPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=e926d25229e0cdc77a8a43516f5ebce81c85d629;hb=e4b9c7f546318de7603566b141fd0e2d0118c794;hp=95404b3b540d8755c00ca7273342a0d99de1843e;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 95404b3b..e926d252 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier

+DynamicThreadPool | poolifier

@@ -96,7 +96,7 @@ When the maximum number of threads is reached and workers are busy, an event is

constructor

new DynamicThreadPool<Data, Response>(min: number, max: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
new DynamicThreadPool<Data, Response>(min: number, max: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
Constructs a new poolifier dynamic thread pool.

@@ -126,20 +126,25 @@ When the maximum number of threads is reached and workers are busy, an event is
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

Options for this dynamic thread pool.

Returns DynamicThreadPool<Data, Response>

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Inherit Doc

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

`Readonly` filePath

filePath: string

@@ -147,14 +152,14 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Readonly` max

max: number

Maximum number of threads that can be created by this pool.

Defined in src/pools/thread/dynamic.ts:31

`Readonly` numberOfWorkers

numberOfWorkers: number

@@ -162,7 +167,7 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Readonly` opts

opts: PoolOptions<ThreadWorkerWithMessageChannel>

@@ -170,10 +175,10 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Protected` promiseResponseMap

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

The execution response promise map.

key: The message id of each submitted task.

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

`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:61

`Readonly` workerNodes

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

Inherit Doc

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

Accessors

@@ -208,23 +213,25 @@ When the maximum number of threads is reached and workers are busy, an event is

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

Returns boolean
Overrides FixedThreadPool.busy
- Defined in src/pools/thread/dynamic.ts:49

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

full

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

Returns boolean
Overrides FixedThreadPool.full
- Defined in src/pools/thread/dynamic.ts:44

Defined in src/pools/thread/dynamic.ts:44

`Private` numberOfQueuedTasks

Returns number

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

`Private` numberOfRunningTasks

Returns number

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

type

get type(): PoolType
-
-
Inherit Doc
+
Pool type.
+
If it is 'dynamic', it provides the max property.
+

Returns PoolType
Overrides FixedThreadPool.type
- Defined in src/pools/thread/dynamic.ts:39

Defined in src/pools/thread/dynamic.ts:39

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.
@@ -276,29 +284,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:327

`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

Returns void

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

`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>]
+
Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
Inherited from FixedThreadPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:337

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

`Protected` createAndSetupWorker

Returns ThreadWorkerWithMessageChannel

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

`Protected` createWorker

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

Returns ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.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 FixedThreadPool.destroy
- Defined in src/pools/abstract-pool.ts:256

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

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

execute

execute(data: Data): Promise<Response>
execute(data: Data): Promise<Response>
-
-
Inherit Doc
+
Performs the task specified in the constructor with the data parameter.
+ +
Returns
Promise that will be resolved when the task is successfully completed.
+
Parameters
- -
  data: Data
-
Returns Promise<Response>
+
data: Data
+
The input for the specified task. This can only be serializable data.
+

Returns Promise<Response>

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

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 FixedThreadPool.findFreeWorkerNodeKey
- Defined in src/pools/abstract-pool.ts:221

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

`Protected` internalBusy

Returns boolean

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

`Protected` isMain

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

Returns boolean
Inherited from FixedThreadPool.isMain
- Defined in src/pools/thread/fixed.ts:49

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

registerWorkerMessageListener

registerWorkerMessageListener<Message>(messageChannel: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
registerWorkerMessageListener<Message>(messageChannel: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
-
Inherit Doc
+
Registers a listener callback on the given worker.
+
Type Parameters
Returns void
Inherited from FixedThreadPool.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>
+
message: MessageValue<Data, unknown>
+
The message.
+

Returns void

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

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): 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.
+

Returns void

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

`Protected` setupHook

Returns void

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

`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.
    @@ -533,15 +564,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

constructor

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

Inherit Doc

worker: ThreadWorkerWithMessageChannel

worker: ThreadWorkerWithMessageChannel

data: Data

messageChannel: ThreadWorkerWithMessageChannel

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

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

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Member Visibility

Theme