X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=9839ac139b1984a50c829efd4060c78d7cf895c8;hb=afc003b20097712625ffd053e256ef5336e27b6e;hp=72bfbbc053aca922843fc27487f301fadf8154a6;hpb=fe9f25b5ac98c7c7fccd1849a200c5054a77cf03;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 72bfbbc0..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,37 +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
-tasks
+promise Response Map
worker Choice Strategy Context
workers
Properties
Accessors
Methods
-constructor
-- new
Dynamic Thread Pool<Data, Response>(min: number, max: number, filePath: string, opts??: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
+- new
Dynamic Thread Pool<Data, Response>(min: number, max: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
-
@@ -125,95 +123,84 @@ When the maximum number of threads is reached, an event is emitted. If you want
-
-
Constructs a new poolifier dynamic thread pool.
Path to an implementation of a
ThreadWorker
file, which can be relative or absolute.
+Optional
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this dynamic thread pool.
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:79
+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:57
Of Workers
-Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedThreadPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:78
-Readonly
optsOptions for the pool.
+Inherited from FixedThreadPool.opts
-- Defined in src/pools/abstract-pool.ts:80
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
--- Defined in src/pools/abstract-pool.ts:49
-Readonly
tasksInherit Doc
Inherited from FixedThreadPool.tasks
+Inherited from FixedThreadPool.promiseResponseMap
-- Defined in src/pools/abstract-pool.ts:33
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:64
-Readonly
workersInherit Doc
{@inheritDoc}
+Inherited from FixedThreadPool.workers
-- Defined in src/pools/abstract-pool.ts:30
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:150
type
Inherit Doc
{@inheritDoc}
+Returns PoolType
Overrides FixedThreadPool.type
-- Defined in src/pools/thread/dynamic.ts:39
Methods
+ Promise Response Hook
+Protected
after+- after
Promise Response Hook(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Response, unknown>): void
+-
+
+
+
+
+
Hook executed after the worker task promise resolution. +Can be overridden.
+Parameters
++-
+
+-
+
worker: ThreadWorkerWithMessageChannel
+The worker.
+message: MessageValue<Response, unknown>
+The received message.
+Returns void
Inherited from FixedThreadPool.afterPromiseResponseHook
++- Defined in src/pools/abstract-pool.ts:278
Protected
afterInherit Doc
{@inheritDoc}
+Parameters
@@ -266,21 +287,40 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Returns void
Inherited from FixedThreadPool.afterWorkerSetup
-- Defined in src/pools/thread/fixed.ts:80
Promise Response Hook
+Protected
before+- before
Promise Response Hook(workerKey: number): void
+-
+
+
+
+
+
Hook executed before the worker task promise resolution. +Can be overridden.
+Parameters
++-
+
workerKey: number
+The worker key.
+Returns void
Inherited from FixedThreadPool.beforePromiseResponseHook
++- Defined in src/pools/abstract-pool.ts:267
Protected
choose-- choose
Worker(): ThreadWorkerWithMessageChannel
+- choose
Worker(): [number, ThreadWorkerWithMessageChannel]
-
-
-
+
+- 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
+
+
-
-
-
-
Choose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker for the next task.
+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:283
Protected
create@@ -293,54 +333,36 @@ When the maximum number of threads is reached, an event is emitted. If you want
Returns ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:337
Protected
createInherit Doc
{@inheritDoc}
+Returns ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.createWorker
-- Defined in src/pools/thread/fixed.ts:73
Workers Tasks
-Protected
decrease-- decrease
Workers Tasks(worker: ThreadWorkerWithMessageChannel): void
--
-
-
-
-
-
Decrease the number of tasks that the given worker has applied.
-Parameters
---
-
worker: ThreadWorkerWithMessageChannel
-Worker whose tasks are decreased.
-Returns void
Inherited from FixedThreadPool.decreaseWorkersTasks
--- Defined in src/pools/abstract-pool.ts:246
destroy
Inherit Doc
{@inheritDoc}
+Returns Promise<void>
Inherited from FixedThreadPool.destroy
-- Defined in src/pools/abstract-pool.ts:208
destroy Worker
Inherit Doc
{@inheritDoc}
+Parameters
@@ -349,14 +371,14 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Returns Promise<void>
Inherited from FixedThreadPool.destroyWorker
-- Defined in src/pools/thread/fixed.ts:49
execute
Inherit Doc
{@inheritDoc}
+Parameters
@@ -365,111 +387,45 @@ When the maximum number of threads is reached, an event is emitted. If you want
-Returns Promise<Response>
Inherited from FixedThreadPool.execute
-- Defined in src/pools/abstract-pool.ts:196
find Free Worker
--- find
Free Worker(): false | ThreadWorkerWithMessageChannel
--
-
-
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
Inherited from FixedThreadPool.findFreeWorker
--- Defined in src/pools/abstract-pool.ts:185
get Worker Index
+find Free Worker Key
-- get
Worker Index(worker: ThreadWorkerWithMessageChannel): number
--
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns number
Inherited from FixedThreadPool.getWorkerIndex
--- Defined in src/pools/abstract-pool.ts:160
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:155
Workers Task
-Protected
increase-- increase
Workers Task(worker: ThreadWorkerWithMessageChannel): void
+- find
Free Worker Key(): number
-
-
-
-
-
-
-
-
-
-- 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
Increase the number of tasks that the given worker has applied.
+{@inheritDoc}
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
-Worker whose tasks are increased.
-Returns void
Inherited from FixedThreadPool.increaseWorkersTask
--- Defined in src/pools/abstract-pool.ts:237
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:308
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:177
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
@@ -496,7 +452,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
Returns void
Inherited from FixedThreadPool.registerWorkerMessageListener
-- Defined in src/pools/thread/fixed.ts:65
Protected
remove@@ -509,19 +465,19 @@ When the maximum number of threads is reached, an event is emitted. If you want-
worker: ThreadWorkerWithMessageChannel
-Worker that will be removed.
+The worker that will be removed.
Returns void
Inherited from FixedThreadPool.removeWorker
-- Defined in src/pools/abstract-pool.ts:270
Protected
sendInherit Doc
{@inheritDoc}
+Parameters
@@ -532,23 +488,23 @@ When the maximum number of threads is reached, an event is emitted. If you want
+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"): 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"
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:165
Protected
setup@@ -560,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:223
Protected
worker@@ -588,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:361
@@ -617,31 +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
-- tasks
+- promise
Response Map
- worker
Choice Strategy Context
- workers
- busy
-- number
Of Running Tasks
+- full
+- number
Of Running Tasks
- type
+- after
Promise Response Hook
- after
Worker Setup
+- before
Promise Response Hook
- choose
Worker
- create
And Setup Worker
- create
Worker
-- decrease
Workers Tasks
- destroy
- destroy
Worker
- execute
-- find
Free Worker
-- get
Worker Index
-- get
Worker Running Tasks
-- increase
Workers Task
-- internal
Execute
-- internal
Get Busy Status
+- find
Free Worker Key
+- internal
Busy
- is
Main
- register
Worker Message Listener
- remove
Worker