X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=b9b5f244809ffb282067aa9c6e2aaf5c04760920;hb=2624da4d8f724e8bc0b655cddfc6ba5ae9a4d053;hp=cbbc5b2def4b48f98f57d9fddd3c3af7775c93fb;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index cbbc5b2d..b9b5f244 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -30,12 +30,12 @@ When the maximum number of threads is reached and workers are busy, an event is
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
+run Time
type
+utilization
worker
Properties
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.
Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -254,7 +255,7 @@ When the maximum number of threads is reached and workers are busy, an event is
info
@@ -266,7 +267,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
max@@ -278,7 +279,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
min@@ -290,7 +291,20 @@ When the maximum number of threads is reached and workers are busy, an event is
Time
+Private
run+- get runTime(): number
+-
+
+
Gets the pool run time.
+Returns number
The pool run time in milliseconds.
+ +Protected
type@@ -303,7 +317,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@@ -315,7 +342,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@@ -390,70 +417,70 @@ Can be overridden.
Worker Node
+Protected
chooseProtected
create-- choose
Worker Node(): number
+- create
And Setup Dynamic Worker(): Worker
-
-
-- Defined in src/pools/abstract-pool.ts:793
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:760
Worker
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 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:73
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:503
Worker
- destroy
Worker(worker): Promise<void>
-
-
-
-
@@ -461,7 +488,7 @@ Can be overridden.
+- Defined in src/pools/thread/fixed.ts:62
+- Defined in src/pools/abstract-pool.ts:409
+- Defined in src/pools/thread/fixed.ts:68
+- Defined in src/pools/abstract-pool.ts:421
+- Defined in src/pools/abstract-pool.ts:376
+- Defined in src/pools/abstract-pool.ts:398
Hook
- setup
Hook(): void
-
-
+- Defined in src/pools/abstract-pool.ts:526
Listener
+
+ - Defined in src/pools/abstract-pool.ts:818
@@ -739,12 +729,14 @@ Can be overridden
- info
- max
Size
- min
Size
+- run
Time
- type
+- utilization
- worker
- after
Task Execution Hook
- after
Worker Setup
- before
Task Execution Hook
-- choose
Worker Node
+- create
And Setup Dynamic Worker
- create
And Setup Worker
- create
Worker
- destroy
@@ -753,7 +745,6 @@ Can be overridden
- execute
- internal
Busy
- is
Main
-- register
Worker Message Listener
- send
To Worker
- set
Tasks Queue Options
- set
Worker Choice Strategy
@@ -787,6 +778,7 @@ Can be overridden
- Pool
Info
- Pool
Options
- Promise
Response Wrapper
+- Strategy
Policy
- Task
- Task
Error
- Task
Performance
@@ -795,12 +787,12 @@ Can be overridden
- Tasks
Queue Options
- Thread
Pool Options
- Worker
Choice Strategy Options
+- Worker
Info
- Worker
Node
- Worker
Options
- Worker
Statistics
- Worker
Usage
-- Draft
-- Error
Handler
+- Error
Handler
- Exit
Handler
- Kill
Behavior
- Measurement
@@ -809,7 +801,6 @@ Can be overridden
- Pool
Event
- Pool
Type
- Task
Functions
-- Thread
Worker With Message Channel
- Worker
Async Function
- Worker
Choice Strategy
- Worker
Function
@@ -820,7 +811,8 @@ Can be overridden
- Pool
Events
- Pool
Types
- Worker
Choice Strategies
-- Worker
Types
+ - Worker
Types
+- available
Parallelism
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
@@ -486,7 +513,7 @@ Can be overridden.
execute
@@ -499,7 +526,7 @@ Can be overridden.-
-
@@ -512,16 +539,20 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:469
Busy
- internal
Busy(): boolean
-
-
+- Defined in src/pools/abstract-pool.ts:460
Main
-
-
+- Defined in src/pools/thread/fixed.ts:57
To Worker
@@ -599,7 +589,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@@ -533,48 +564,7 @@ Can be overridden.
Inherited from FixedThreadPool.isMain
-- Defined in src/pools/thread/fixed.ts:65
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:86
Protected
send@@ -586,12 +576,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:78
set Tasks Queue Options
@@ -619,7 +609,7 @@ Can be overridden.
Inherited from FixedThreadPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:348
set Worker Choice Strategy
@@ -644,7 +634,7 @@ Can be overridden.
Inherited from FixedThreadPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:303
set Worker Choice Strategy Options
@@ -664,20 +654,20 @@ Can be overridden.
Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:325
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:449
Protected
worker@@ -698,14 +688,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:705