X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=9839ac139b1984a50c829efd4060c78d7cf895c8;hb=afc003b20097712625ffd053e256ef5336e27b6e;hp=986df6156e33bd2478a2ae0216927dd37ba0f4dc;hpb=301c53e7ae6cf1120298ea10868a9091904c01a2;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 986df615..9839ac13 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,13 @@
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
This thread pool creates new threads when the others are busy, up to the maximum number of threads. -When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's
- -emitter
.Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
+When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
.Author
Alessandro Pio Ardizio
@@ -30,9 +28,13 @@ When the maximum number of threads is reached, an event is emitted. If you wantType Parameters
Data = unknown
Data = unknown
+Type of data sent to the worker. This can only be serializable data.
+Response = unknown
Response = unknown
+Type of response of execution. This can only be serializable data.
+Hierarchy
@@ -40,7 +42,7 @@ When the maximum number of threads is reached, an event is emitted. If you want- DynamicThreadPool
@@ -54,39 +56,33 @@ When the maximum number of threads is reached, an event is emitted. If you wantemitter?
file Path
-max
-next Message Id
+max
number Of Workers
opts
-promise Map
+promise Response Map
worker Choice Strategy Context
workers
-workers Tasks Usage
Properties
Accessors
Methods
-Returns DynamicThreadPool<Data, Response>
+Properties
-Optional
Readonly
emitterInherit Doc
Path
-Readonly
filePath to the worker-file.
+Inherited from FixedThreadPool.filePath
-- Defined in src/pools/abstract-pool.ts:85
+Readonly
maxPrivate
Readonly
maxInherit Doc
Inherited from FixedThreadPool.max
--- Defined in src/pools/thread/dynamic.ts:31
Message Id
-Protected
nextId of the next message.
+Maximum number of threads that can be created by this pool.
Inherited from FixedThreadPool.nextMessageId
-- Defined in src/pools/abstract-pool.ts:63
Of Workers
-Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedThreadPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:84
-Readonly
optsOptions for the pool.
+Inherited from FixedThreadPool.opts
-- Defined in src/pools/abstract-pool.ts:86
Map
-Protected
promiseThe promise map.
+ Response Map
+Protected
promiseThe promise response map.
-
-
+
+
-key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
+When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
Inherited from FixedThreadPool.promiseMap
+Inherited from FixedThreadPool.promiseResponseMap
-- Defined in src/pools/abstract-pool.ts:55
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Inherited from FixedThreadPool.workerChoiceStrategyContext
-- Defined in src/pools/abstract-pool.ts:70
-Readonly
workersInherit Doc
{@inheritDoc}
+Inherited from FixedThreadPool.workers
-- Defined in src/pools/abstract-pool.ts:33
Tasks Usage
-Readonly
workersInherit Doc
Inherited from FixedThreadPool.workersTasksUsage
--- Defined in src/pools/abstract-pool.ts:36
Accessors
Inherit Doc
{@inheritDoc}
+Returns boolean
Overrides FixedThreadPool.busy
-- Defined in src/pools/thread/dynamic.ts:44
number Of Running Tasks
-+- Defined in src/pools/thread/dynamic.ts:49
full
++- get full(): boolean
+-
+
+
+
{@inheritDoc}
+Returns boolean
Overrides FixedThreadPool.full
++- Defined in src/pools/thread/dynamic.ts:44
Of Running Tasks
+Private
numberInherit Doc
Number of tasks concurrently running in the pool.
+Returns number
Inherited from FixedThreadPool.numberOfRunningTasks
-- Defined in src/pools/abstract-pool.ts:156
type
Inherit Doc
{@inheritDoc}
+Returns PoolType
Overrides FixedThreadPool.type
-- Defined in src/pools/thread/dynamic.ts:39
Methods
- Promise Worker Response Hook
+Protected
afterProtected
after-- after
Promise Worker Response Hook(message: MessageValue<Response, unknown>, promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>): void
+- after
Promise Response Hook(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Response, unknown>): void
-
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:278
Worker Setup
- after
Worker Setup(worker: ThreadWorkerWithMessageChannel): void
-
-
-
+
-- Defined in src/pools/thread/fixed.ts:85
+
+ Promise Response Hook
Hook executed after the worker task promise resolution. Can be overridden.
@@ -265,24 +261,24 @@ Can be overridden.Parameters
message: MessageValue<Response, unknown>
-The received message.
+worker: ThreadWorkerWithMessageChannel
+The worker.
promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>
-The Promise response.
+message: MessageValue<Response, unknown>
+The received message.
Returns void
Inherited from FixedThreadPool.afterPromiseWorkerResponseHook
+Inherited from FixedThreadPool.afterPromiseResponseHook
-- Defined in src/pools/abstract-pool.ts:263
Protected
afterInherit Doc
{@inheritDoc}
+Parameters
@@ -291,11 +287,11 @@ Can be overridden.
-Returns void
Inherited from FixedThreadPool.afterWorkerSetup
-- Defined in src/pools/thread/fixed.ts:80
Promise Worker Response Hook
+Protected
beforeProtected
before-- before
Promise Worker Response Hook(worker: ThreadWorkerWithMessageChannel): void
+- before
Promise Response Hook(workerKey: number): void
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:267
Worker
+- Defined in src/pools/abstract-pool.ts:307
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:352
Worker
- create
Worker(): ThreadWorkerWithMessageChannel
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:78
- destroy(): Promise<void>
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:233
- destroy
Worker(worker: ThreadWorkerWithMessageChannel): Promise<void>
-
-
-
+
- Defined in src/pools/thread/fixed.ts:54
- execute(data: Data): Promise<Response>
-
-
-
+
-
-
-- Defined in src/pools/abstract-pool.ts:217
+
+
-
-
-
-
-
-
Hook executed before the worker task promise resolution. Can be overridden.
@@ -304,27 +300,27 @@ Can be overridden.Parameters
worker: ThreadWorkerWithMessageChannel
-The worker.
+workerKey: number
+The worker key.
Returns void
Inherited from FixedThreadPool.beforePromiseWorkerResponseHook
+Inherited from FixedThreadPool.beforePromiseResponseHook
-- Defined in src/pools/abstract-pool.ts:252
Protected
choose-- choose
Worker(): ThreadWorkerWithMessageChannel
+- choose
Worker(): [number, ThreadWorkerWithMessageChannel]
-
-
+
Chooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+The default uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker key, worker].
Returns ThreadWorkerWithMessageChannel
Returns [number, ThreadWorkerWithMessageChannel]
Inherited from FixedThreadPool.chooseWorker
-- Defined in src/pools/abstract-pool.ts:290
Protected
create@@ -337,36 +333,36 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:344
Protected
createInherit Doc
{@inheritDoc}
+Returns ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.createWorker
-- Defined in src/pools/thread/fixed.ts:73
destroy
Inherit Doc
{@inheritDoc}
+Returns Promise<void>
Inherited from FixedThreadPool.destroy
-- Defined in src/pools/abstract-pool.ts:222
destroy Worker
Inherit Doc
{@inheritDoc}
+Parameters
@@ -375,14 +371,14 @@ Can be overridden.
+Returns Promise<void>
Inherited from FixedThreadPool.destroyWorker
-- Defined in src/pools/thread/fixed.ts:49
execute
Inherit Doc
{@inheritDoc}
+Parameters
@@ -391,127 +387,45 @@ Can be overridden.
-Returns Promise<Response>
Inherited from FixedThreadPool.execute
-- Defined in src/pools/abstract-pool.ts:210
find Free Worker
--- find
Free Worker(): false | ThreadWorkerWithMessageChannel
--
-
-
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.findFreeWorker
--- Defined in src/pools/abstract-pool.ts:199
get Worker Average Tasks Run Time
+find Free Worker Key
-- get
Worker Average Tasks Run Time(worker: ThreadWorkerWithMessageChannel): undefined | number
+- find
Free Worker Key(): number
-
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
Inherited from FixedThreadPool.getWorkerAverageTasksRunTime
--- Defined in src/pools/abstract-pool.ts:171
get Worker Index
--- get
Worker Index(worker: ThreadWorkerWithMessageChannel): number
--
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns number
Inherited from FixedThreadPool.getWorkerIndex
--- Defined in src/pools/abstract-pool.ts:161
get Worker Running Tasks
--- get
Worker Running Tasks(worker: ThreadWorkerWithMessageChannel): undefined | number
--
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
Inherited from FixedThreadPool.getWorkerRunningTasks
--- Defined in src/pools/abstract-pool.ts:166
init Worker Tasks Usage
--- init
Worker Tasks Usage(worker: ThreadWorkerWithMessageChannel): void
--
-
-
-
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:210
+
+ Busy
+- Defined in src/pools/abstract-pool.ts:202
Main
- is
Main(): boolean
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:49
- register
Worker Message Listener<Message>(messageChannel: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:70
Worker
+- Defined in src/pools/abstract-pool.ts:475
To Worker
- send
To Worker(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Data, unknown>): void
-
-
-
+
- Defined in src/pools/thread/fixed.ts:62
+- Defined in src/pools/abstract-pool.ts:178
Hook
+- Defined in src/pools/abstract-pool.ts:252
Listener
+ - Defined in src/pools/abstract-pool.ts:381
Initializes tasks usage statistics.
+{@inheritDoc}
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
-The worker.
-Returns void
Inherited from FixedThreadPool.initWorkerTasksUsage
--- Defined in src/pools/abstract-pool.ts:470
Execute
-Protected
internal-- internal
Execute(worker: ThreadWorkerWithMessageChannel, messageId: number): Promise<Response>
--
-
-
-
-
+
Parameters
---
-
--
-
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
Inherited from FixedThreadPool.internalExecute
+Returns number
Inherited from FixedThreadPool.findFreeWorkerKey
-- Defined in src/pools/abstract-pool.ts:315
Get Busy Status
+Protected
internalProtected
internal-- internal
Get Busy Status(): boolean
+- internal
Busy(): boolean
-
-
Returns boolean
Inherited from FixedThreadPool.internalGetBusyStatus
+Inherited from FixedThreadPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:191
Protected
isInherit Doc
{@inheritDoc}
+Returns boolean
Inherited from FixedThreadPool.isMain
-- Defined in src/pools/thread/fixed.ts:44
register Worker Message Listener
Inherit Doc
{@inheritDoc}
+Type Parameters
@@ -538,7 +452,7 @@ Can be overridden.
Returns void
Inherited from FixedThreadPool.registerWorkerMessageListener
-- Defined in src/pools/thread/fixed.ts:65
Protected
remove@@ -556,14 +470,14 @@ Can be overridden.
Returns void
Inherited from FixedThreadPool.removeWorker
-- Defined in src/pools/abstract-pool.ts:277
Protected
sendInherit Doc
{@inheritDoc}
+Parameters
@@ -574,23 +488,23 @@ Can be overridden.
+Returns void
Inherited from FixedThreadPool.sendToWorker
-- Defined in src/pools/thread/fixed.ts:57
set Worker Choice Strategy
-- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
-
-
-
+
-
-
+
Inherit Doc
{@inheritDoc}
+Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
Inherited from FixedThreadPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:176
Protected
setup@@ -602,7 +516,7 @@ to run code before workers are created in the abstract constructor.
Returns void
Inherited from FixedThreadPool.setupHook
-- Defined in src/pools/abstract-pool.ts:237
Protected
worker@@ -630,7 +544,7 @@ to run code before workers are created in the abstract constructor.
Returns void
Inherited from FixedThreadPool.workerListener
-- Defined in src/pools/abstract-pool.ts:368
@@ -659,33 +573,27 @@ to run code before workers are created in the abstract constructor.- constructor
- emitter?
- file
Path
-- max
-- next
Message Id
+- max
- number
Of Workers
- opts
-- promise
Map
+- promise
Response Map
- worker
Choice Strategy Context
- workers
-- workers
Tasks Usage
- busy
-- number
Of Running Tasks
+- full
+- number
Of Running Tasks
- type
-- after
Promise Worker Response Hook
+- after
Promise Response Hook
- after
Worker Setup
-- before
Promise Worker Response Hook
+- before
Promise Response Hook
- choose
Worker
- create
And Setup Worker
- create
Worker
- destroy
- destroy
Worker
- execute
-- find
Free Worker
-- get
Worker Average Tasks Run Time
-- get
Worker Index
-- get
Worker Running Tasks
-- init
Worker Tasks Usage
-- internal
Execute
-- internal
Get Busy Status
+- find
Free Worker Key
+- internal
Busy
- is
Main
- register
Worker Message Listener
- remove
Worker