Readonly
Protected
Id of the next message.
Path to the worker-file.
The promise map.
The execution response promise map.
key
value
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.
Worker 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.
Private
Number of tasks queued in the pool.
Number of tasks running in the pool.
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
The worker.
The Promise response.
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker node key.
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.
Worker.
[worker node key, worker node].
Creates 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.
New, completely set up worker.
Removes the given worker from the pool.
The worker that will be removed.
Setup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
This function is the listener registered for each worker.
This function is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
Id of the next message.
+Path to the worker-file.
-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.
-Readonlyworkers
+ReadonlyworkerInherit Doc
-ReadonlyworkersInherit Doc
Accessors
Returns boolean
number
--- get numberOfRunningTasks(): number
+- Defined in src/pools/thread/fixed.ts:105
full
++- get full(): boolean
-
+
Inherit Doc
Returns boolean
+Privatenumber+- get numberOfQueuedTasks(): number
+-
+
Number of tasks queued in the pool.
+Returns number
+Privatenumber+- get numberOfRunningTasks(): number
+-
+
Number of tasks running in the pool.
+Returns number
type
@@ -240,32 +247,32 @@
Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:304
-
-- Defined in src/pools/thread/fixed.ts:85
+
+
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. 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
Protectedafter@@ -281,53 +288,53 @@ Can be overridden.
Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
-
-- Defined in src/pools/abstract-pool.ts:293
+
+
+- Defined in src/pools/abstract-pool.ts:189
- setup
-
-
- Defined in src/pools/abstract-pool.ts:278
- worker
-
-
- (message: MessageValue<Response, unknown>): void
-
-
- Defined in src/pools/abstract-pool.ts:422
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
-
-
-worker: ThreadWorkerWithMessageChannel
-The worker.
+workerNodeKey: number
+The worker node key.
Returns void
+ProtectedchooseProtectedchoose-- choose
+- choose
-
-
- create
-
-
- Defined in src/pools/abstract-pool.ts:399
+- Defined in src/pools/thread/fixed.ts:78
+- Defined in src/pools/abstract-pool.ts:256
+- Defined in src/pools/thread/fixed.ts:54
-
-
-
-- Defined in src/pools/abstract-pool.ts:228
+
+
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:221
+
+
-
-
+- Defined in src/pools/abstract-pool.ts:216
+- Defined in src/pools/thread/fixed.ts:49
-
-
+- Defined in src/pools/thread/fixed.ts:70
+- Defined in src/pools/thread/fixed.ts:62
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 ThreadWorkerWithMessageChannel
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 ThreadWorkerWithMessageChannel
+Protectedcreate@@ -338,7 +345,7 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
destroy
@@ -349,7 +356,7 @@ Can be overridden.
Returns Promise<void>
destroy
@@ -365,7 +372,7 @@ Can be overridden.
Returns Promise<void>
execute
@@ -381,91 +388,27 @@ Can be overridden.
Returns Promise<Response>
find
--- find
--
-
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
get
+find
-- get
+- find
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
get
--- get
--
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
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
Protectedis@@ -476,7 +419,7 @@ Can be overridden.
Returns boolean
register
@@ -510,25 +453,7 @@ Can be overridden.
Returns void
-Protectedremove-- remove
--
-
-
-
Removes the given worker from the pool.
-Parameters
---
-
worker: ThreadWorkerWithMessageChannel
-The worker that will be removed.
-Returns void
Protectedsend@@ -546,11 +471,11 @@ Can be overridden.
Returns void
set
-- set
+- set
-
@@ -558,29 +483,29 @@ Can be overridden.
-
-
Inherit Doc
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
ProtectedsetupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Returns void
+ProtectedworkerThis 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.
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 void
@@ -631,34 +556,29 @@ to run code before workers are created in the abstract constructor.- constructor
- emitter?
- file
-- next
- number
- opts
-- promise
+- promise
- worker
-- workers
-- workers
+- worker
- busy
-- number
+- full
+- number
+- number
- type
-- after
+- after
- after
-- before
-- choose
+- before
+- choose
- create
- create
- destroy
- destroy
- execute
-- find
-- get
-- get
-- get
-- internal
-- internal
+- find
+- internal
- is
- register
-- remove
- send
- set
- setup