A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
-When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter.emitter.Author
Christopher Quadflieg
@@ -38,11 +38,11 @@ When the maximum number of workers is reached, an event is emitted. If you wantHierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -56,41 +56,36 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file
Properties
Accessors
Methods
-constructor
-- new
+- new
-
Constructs a new poolifier dynamic cluster pool.
opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
Properties
OptionalReadonlyemitterInherit Doc
-Readonlyfile
-ProtectedReadonlymax
-ProtectednextId of the next message.
+
+ReadonlymaxMaximum number of workers that can be created by this pool.
-Readonlynumber
-Readonlyopts
-ProtectedpromiseThe promise map.
+
+ProtectedpromiseThe execution response promise 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 execution response 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 id.
-ProtectedworkerWorker 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.
-ReadonlyworkersInherit Doc
-ReadonlyworkersInherit Doc
+ReadonlyworkerPool worker nodes.
+Accessors
Inherit Doc
Whether the pool is busy or not.
+The pool busyness boolean status.
+Returns boolean
number
-+- Defined in src/pools/cluster/dynamic.ts:48
full
++- get full(): boolean
+-
+
Whether the pool is full or not.
+The pool filling boolean status.
+Returns boolean
+Privatenumber+- get numberOfQueuedTasks(): number
+-
+
Number of tasks queued in the pool.
+Returns number
+PrivatenumberInherit Doc
Number of tasks running in the pool.
+Returns number
type
Inherit Doc
Pool type.
+If it is
+'dynamic', it provides themaxproperty.Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
-
-- Defined in src/pools/cluster/fixed.ts:93
+
+
-
-
+- Defined in src/pools/cluster/fixed.ts:80
- Defined in src/pools/cluster/fixed.ts:75
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
Parameters
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:327
- after
-
-
-
+
-
-
+
-message: MessageValue<Response, unknown>
-The received message.
+worker: Worker
+The worker.
promise: PromiseWorkerResponseWrapper<Worker, Response>
-The Promise response.
+message: MessageValue<Response, unknown>
+The received message.
Returns void
ProtectedafterInherit Doc
Function 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
+maxListenersor binding themain-worker<->workerconnection if not bind by default.Parameters
worker: Worker
worker: Worker
+The newly created worker.
+Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
-
-- Defined in src/pools/abstract-pool.ts:316
+
+
-
-
-
-- Defined in src/pools/abstract-pool.ts:248
+
+
-
-
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:241
+
+
+- Defined in src/pools/abstract-pool.ts:236
- is
-
-
-
+
+- Defined in src/pools/cluster/fixed.ts:64
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
-
-
-worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
Returns void
+ProtectedchooseProtectedchoose-- choose
+- choose
-
-
- create
-
-
- Defined in src/pools/abstract-pool.ts:422
- create
-
-
-
+
+- Defined in src/pools/cluster/fixed.ts:88
- destroy(): Promise<void>
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:279
- destroy
-
-
-
+
-
-
+
+- Defined in src/pools/cluster/fixed.ts:69
Chooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker node key, worker node].
Returns Worker
ProtectedcreateCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
Returns
New, completely set up worker.
Returns Worker
+ProtectedcreateInherit Doc
Returns a newly created worker.
+Returns Worker
destroy
Inherit Doc
Shutdowns every current worker in this pool.
+Returns Promise<void>
destroy
Inherit Doc
Shutdowns the given worker.
+Parameters
worker: Worker
worker: Worker
+A worker within
+workerNodes.Returns void
execute
-- execute(data: Data): Promise<Response>
+- execute(data: Data): Promise<Response>
-
-
-
+
-
-
-
Inherit Doc
Performs the task specified in the constructor with the data parameter.
+ +Returns
Promise that will be resolved when the task is successfully completed.
+Parameters
data: Data
Returns Promise<Response>
Returns Promise<Response>
find
--- find
--
-
-
-
Inherit Doc
Returns false | Worker
get
+find
-- get
+- find
-
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: Worker
Returns undefined | number
get
--- get
--
-
-
-
-
+
Inherit Doc
Parameters
---
-
worker: Worker
Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with
+0running tasks, it is detected as free and its worker node key is returned.If no free worker is found,
+ +-1is returned.Returns
A worker node key if there is one,
+-1otherwise.Returns number
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: Worker
Returns undefined | number
-Protectedinternal-- internal
--
-
-
-
Parameters
---
-
--
-
worker: Worker
messageId: number
Returns Promise<Response>
+ProtectedinternalProtectedinternal-- internal
+- internal
-
Returns boolean
ProtectedisInherit Doc
Should return whether the worker is the main worker or not.
+Returns boolean
register
-- register
+- register
-
-
-
+
-
-
-
Inherit Doc
Registers a listener callback on the given worker.
+Type Parameters
@@ -501,103 +467,96 @@ Can be overridden.-
-
+
Parameters
worker: Worker
worker: Worker
+The worker which should register a listener.
+listener: ((message: MessageValue<Message, unknown>) => void)
+listener: ((message: MessageValue<Message, unknown>) => void)
+The message listener callback.
+-- (message: MessageValue<Message, unknown>): void
+- (message: MessageValue<Message, unknown>): void
-
-
-
+
Parameters
message: MessageValue<Message, unknown>
message: MessageValue<Message, unknown>
Returns void
Returns void
-Protectedremove-- remove
--
-
-
-
Removes the given worker from the pool.
-Parameters
---
-
worker: Worker
-The worker that will be removed.
-Returns void
Protectedsend-- send
+- send
-
-
-
+
-
-
+-
-
+
Inherit Doc
Sends a message to the given worker.
+Parameters
worker: Worker
worker: Worker
+The worker which should receive the message.
+message: MessageValue<Data, unknown>
message: MessageValue<Data, unknown>
+The message.
+Returns void
+set
-- set
+- set
-
-
-
+
-
-
+
Inherit Doc
Sets the worker choice strategy in this pool.
+Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+The worker choice strategy.
+Returns void
ProtectedsetupInherit Doc
Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
+Returns void
Protectedworker-- worker
+- worker
-
-
-
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Returns ((message: MessageValue<Response, unknown>) => void)
+Returns ((message: MessageValue<Response, unknown>) => void)
-- (message: MessageValue<Response, unknown>): void
+- (message: MessageValue<Response, unknown>): void
-
-
-
-
This function is the listener registered for each worker.
+This function is the listener registered for each worker message.
Returns
The listener function to execute when a message is received from a worker.
Parameters
message: MessageValue<Response, unknown>
message: MessageValue<Response, unknown>
Returns void
-
+Settings
Settings
Member Visibility
Theme
Generated using TypeDoc