X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=66f365d333157ae357b5d5c65831a7272cd20251;hb=ba92b02f642f229cb927ab526148f10107831471;hp=7b0dfb45650683c5f718e462396938c6ccb85500;hpb=356d077f5c6166732d2df598004bec39ae915725;p=poolifier.git
diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html
index 7b0dfb45..66f365d3 100644
--- a/docs/classes/DynamicThreadPool.html
+++ b/docs/classes/DynamicThreadPool.html
@@ -6,7 +6,7 @@
- Preparing search index...
-- The search index is not available
poolifier
+The search index is not availablepoolifier
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
+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.emitter.Author
Alessandro Pio Ardizio
@@ -42,7 +42,7 @@ When the maximum number of threads is reached, an event is emitted. If you want- DynamicThreadPool
+@@ -56,38 +56,33 @@ When the maximum number of threads is reached, an event is emitted. If you wantemitter?
file
Properties
Accessors
Methods
-Returns DynamicThreadPool<Data, Response>
+Properties
OptionalReadonlyemitterInherit Doc
-Readonlyfile
-ProtectedReadonlymax
-ProtectednextId of the next message.
+
+PrivateReadonlymaxMaximum number of threads that can be created by this pool.
-Readonlynumber
-Readonlyopts
-ProtectedpromiseThe promise map.
+
+ProtectedpromiseThe 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.
Protectedworker
-ReadonlyworkersInherit Doc
-ReadonlyworkersInherit Doc
Accessors
Inherit Doc
{@inheritDoc}
+Returns boolean
number
-+- Defined in src/pools/thread/dynamic.ts:49
full
++- get full(): boolean
+-
+
{@inheritDoc}
+Returns boolean
+PrivatenumberInherit Doc
Number of tasks concurrently running.
+Returns number
type
Inherit Doc
{@inheritDoc}
+Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:267
- after
-
-
-
+
-- Defined in src/pools/thread/fixed.ts:85
+
+
Hook executed after the worker task promise resolution. Can be overridden.
@@ -263,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
ProtectedafterInherit Doc
{@inheritDoc}
+Parameters
@@ -289,11 +287,11 @@ Can be overridden.
-Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
- Defined in src/pools/abstract-pool.ts:256
+- Defined in src/pools/abstract-pool.ts:307
+- Defined in src/pools/abstract-pool.ts:352
- create
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:78
- destroy(): Promise<void>
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:222
- destroy
-
-
-
+
- Defined in src/pools/thread/fixed.ts:54
- execute(data: Data): Promise<Response>
-
-
-
+
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:207
+
+
-
-
-
-- Defined in src/pools/abstract-pool.ts:200
+
+
-
-
+- Defined in src/pools/abstract-pool.ts:192
- is
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:49
- register
-
-
-
+
+- Defined in src/pools/thread/fixed.ts:70
+- Defined in src/pools/abstract-pool.ts:294
- send
-
-
-
+
- Defined in src/pools/thread/fixed.ts:62
+- Defined in src/pools/abstract-pool.ts:168
+- Defined in src/pools/abstract-pool.ts:241
+ - Defined in src/pools/abstract-pool.ts:381
Hook executed before the worker task promise resolution. Can be overridden.
@@ -302,27 +300,27 @@ Can be overridden.Parameters
-
-
+worker: ThreadWorkerWithMessageChannel
-The worker.
+workerKey: number
+The worker key.
Returns void
Protectedchoose-- choose
+- choose
-
Chooses a worker for the next task.
The default implementation uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker key, worker].
Returns ThreadWorkerWithMessageChannel
Protectedcreate@@ -335,36 +333,36 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
ProtectedcreateInherit Doc
{@inheritDoc}
+Returns ThreadWorkerWithMessageChannel
destroy
Inherit Doc
{@inheritDoc}
+Returns Promise<void>
destroy
Inherit Doc
{@inheritDoc}
+Parameters
@@ -373,14 +371,14 @@ Can be overridden.
+Returns Promise<void>
execute
Inherit Doc
{@inheritDoc}
+Parameters
@@ -389,109 +387,45 @@ Can be overridden.
-Returns Promise<Response>
find
--- find
--
-
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
get
+find
-- get
+- find
-
-
-
-
-
+
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
{@inheritDoc}
+Returns number
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
+ProtectedinternalProtectedinternal-- internal
--
-
-
-
Parameters
---
-
--
-
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
-Protectedinternal-- internal
+- internal
-
Returns boolean
ProtectedisInherit Doc
{@inheritDoc}
+Returns boolean
register
Inherit Doc
{@inheritDoc}
+Type Parameters
@@ -518,7 +452,7 @@ Can be overridden.
Returns void
Protectedremove@@ -536,14 +470,14 @@ Can be overridden.
Returns void
ProtectedsendInherit Doc
{@inheritDoc}
+Parameters
@@ -554,23 +488,23 @@ Can be overridden.
+Returns void
set
-- set
+- set
-
-
-
+
-
-
+
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
Protectedsetup@@ -582,7 +516,7 @@ to run code before workers are created in the abstract constructor.
Returns void
Protectedworker@@ -610,7 +544,7 @@ to run code before workers are created in the abstract constructor.
Returns void
@@ -639,32 +573,27 @@ to run code before workers are created in the abstract constructor.- constructor
- emitter?
- file
-- max
-- next
+- max
- number
- opts
-- promise
+- promise
- worker
- workers
-- workers
- busy
-- number
+- full
+- number
- type
-- after
+- after
- after
-- before
+- before
- choose
- create
- create
- destroy
- destroy
- execute
-- find
-- get
-- get
-- get
-- internal
-- internal
+- find
+- internal
- is
- register
- remove