X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=0d7a1467ef7d834428960e0307d9ab1f984e6381;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=a1a2ae7db79542b0ffb46bdb780e8fc3665e3ed0;hpb=f05afd162e34836a52c48b05781750e3421424d8;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index a1a2ae7d..0d7a1467 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
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.
@@ -73,7 +73,9 @@ When the maximum number of threads is reached and workers are busy, an event is info max Size
min Size
+ready
type
+utilization
worker
Properties
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -159,7 +162,7 @@ When the maximum number of threads is reached and workers are busy, an event is +'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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 at least one task.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
fileProtected
Readonly
maxProtected
Readonly
numberProtected
Readonly
opts Response Map
-Protected
promiseThe execution response promise map.
key
: The message id of each submitted task. Choice Strategy Context
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -255,7 +257,7 @@ When the maximum number of threads is reached and workers are busy, an event is
info
@@ -267,7 +269,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
max@@ -279,7 +281,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
min@@ -291,7 +293,16 @@ When the maximum number of threads is reached and workers are busy, an event is
+Private
ready+- get ready(): boolean
+-
+
Returns boolean
Protected
type@@ -304,7 +315,20 @@ When the maximum number of threads is reached and workers are busy, an event is
+Private
utilization+- get utilization(): number
+-
+
+
Gets the approximate pool utilization.
+Returns number
The pool utilization.
+ +Protected
worker@@ -316,7 +340,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Methods
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The worker.
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
Protected
afterFunction 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 themain-worker
<->worker
connection if not bind by default.Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The newly created worker.
Protected
before@@ -391,70 +415,86 @@ Can be overridden.
Worker Node
+Protected
chooseProtected
check-- choose
Worker Node(): number
+- check
Dynamic Pool Size(min, max): void
-
-
+
+
+
+- Defined in src/pools/abstract-pool.ts:972
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:933
Worker
+ - Worker
Types
+- available
Parallelism
Chooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Parameters
++-
+
+-
+
min: number
max: number
Returns void
+ And Setup Dynamic Worker
+Protected
create+- create
And Setup Dynamic Worker(): Worker
+-
+
-
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Returns number
The worker node key
+Returns Worker
New, completely set up dynamic worker.
Protected
create-- create
And Setup Worker(): ThreadWorkerWithMessageChannel
+- create
And Setup Worker(): Worker
-
-
Creates a new worker and sets it up completely in the pool worker nodes.
Returns ThreadWorkerWithMessageChannel
New, completely set up worker.
+Returns Worker
New, completely set up worker.
Protected
create-- create
Worker(): ThreadWorkerWithMessageChannel
+- create
Worker(): Worker
-
-
-- Defined in src/pools/thread/fixed.ts:68
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:646
Worker
- destroy
Worker(worker): Promise<void>
-
-
-
-
@@ -462,7 +502,7 @@ Can be overridden.
+- Defined in src/pools/thread/fixed.ts:57
+- Defined in src/pools/abstract-pool.ts:551
+- Defined in src/pools/thread/fixed.ts:63
+- Defined in src/pools/abstract-pool.ts:563
+- Defined in src/pools/abstract-pool.ts:521
+- Defined in src/pools/abstract-pool.ts:540
Hook
- setup
Hook(): void
-
-
+- Defined in src/pools/abstract-pool.ts:675
Listener
+
+ - Defined in src/pools/abstract-pool.ts:1071
@@ -740,12 +743,15 @@ Can be overridden
- info
- max
Size
- min
Size
+- ready
- type
+- utilization
- worker
- after
Task Execution Hook
- after
Worker Setup
- before
Task Execution Hook
-- choose
Worker Node
+- check
Dynamic Pool Size
+- create
And Setup Dynamic Worker
- create
And Setup Worker
- create
Worker
- destroy
@@ -754,7 +760,6 @@ Can be overridden
- execute
- internal
Busy
- is
Main
-- register
Worker Message Listener
- send
To Worker
- set
Tasks Queue Options
- set
Worker Choice Strategy
@@ -762,7 +767,7 @@ Can be overridden
- setup
Hook
- worker
Listener
-
Returns a newly created worker.
+Creates a new worker.
Returns ThreadWorkerWithMessageChannel
+Returns Worker
Newly created worker.
+ +destroy
Shutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Returns Promise<void>
+Protected
destroyShutdowns the given worker.
+Terminates the given worker.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
A worker within
workerNodes
.enable Tasks Queue
@@ -487,7 +527,7 @@ Can be overridden.
execute
@@ -500,7 +540,7 @@ Can be overridden.-
-
@@ -513,16 +553,20 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:611
Busy
- internal
Busy(): boolean
-
-
+- Defined in src/pools/abstract-pool.ts:602
Main
-
-
+- Defined in src/pools/thread/fixed.ts:52
To Worker
@@ -600,7 +603,7 @@ Can be overridden.
-Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified worker function. This can only be structured-cloneable data.
Protected
internalReturns boolean
Protected
is@@ -534,48 +578,7 @@ Can be overridden.
Inherited from FixedThreadPool.isMain
-- Defined in src/pools/thread/fixed.ts:67
Worker Message Listener
-Protected
register-- register
Worker Message Listener<Message>(worker, listener): void
--
-
-
-
-
-
-
-
Registers a listener callback on the given worker.
-Type Parameters
---
-
Message
Parameters
---
-
-
--
-
-
-
worker: ThreadWorkerWithMessageChannel
-The worker which should register a listener.
-listener: ((message) => void)
-The message listener callback.
---
-
-- (message): void
--
-
-
-
Parameters
---
-
message: MessageValue<Message, unknown, Worker | MessagePort>
Returns void
Returns void
-Inherited from FixedThreadPool.registerWorkerMessageListener
--- Defined in src/pools/thread/fixed.ts:88
Protected
send@@ -587,12 +590,12 @@ Can be overridden.-
-
-
-
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The worker which should receive the message.
message: MessageValue<Data, unknown, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
Inherited from FixedThreadPool.sendToWorker
-- Defined in src/pools/thread/fixed.ts:80
set Tasks Queue Options
@@ -620,7 +623,7 @@ Can be overridden.
Inherited from FixedThreadPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:350
set Worker Choice Strategy
@@ -645,7 +648,7 @@ Can be overridden.
Inherited from FixedThreadPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:305
set Worker Choice Strategy Options
@@ -665,20 +668,20 @@ Can be overridden.
Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:327
Protected
setupSetup 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 FixedThreadPool.setupHook
-- Defined in src/pools/abstract-pool.ts:451
Protected
worker@@ -699,14 +702,14 @@ Can be overridden-
-
Parameters
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
Inherited from FixedThreadPool.workerListener
-- Defined in src/pools/abstract-pool.ts:707